org.thymeleaf.context.IWebContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.everit.osgi.bundles.org.thymeleaf.thymeleaf Show documentation
XML/XHTML/HTML5 template engine for Java
The newest version!
/*
 * =============================================================================
 * 
 *   Copyright (c) 2011-2013, The THYMELEAF team (http://www.thymeleaf.org)
 * 
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 * 
 *       http://www.apache.org/licenses/LICENSE-2.0
 * 
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 * 
 * =============================================================================
 */
package org.thymeleaf.context;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;




/**
 * 
 *   Subinterface of {@link IContext} for implementations that can be
 *   used for creating HTML/XHTML interfaces in web applications.
 * 
 * 
 * @author Daniel Fernández
 * 
 * @since 1.0
 *
 */
public interface IWebContext extends IContext {

    /**
     * 
     *   Returns the {@link HttpServletRequest} object associated with the
     *   request this context has been created for.
     * 
     * 
     * @since 1.1.2
     * @return the HTTP servlet request.
     */
    public HttpServletRequest getHttpServletRequest();

    
    /**
     * 
     *   Returns the {@link HttpServletResponse} object associated with the
     *   request this context has been created for.
     * 
     * 
     * @since 2.0.9
     * @return the HTTP servlet response.
     */
    public HttpServletResponse getHttpServletResponse();

    
    /**
     * 
     *   Returns the {@link HttpSession} object associated with the
     *   request this context has been created for.
     * 
     * 
     * @since 1.1.2
     * @return the HTTP session.
     */
    public HttpSession getHttpSession();
    

    /**
     * 
     *   Returns the {@link ServletContext} object associated with the
     *   web application.
     * 
     * 
     * @return the servlet context.
     */
    public ServletContext getServletContext();


    /**
     * 
     *   Returns a {@link VariablesMap} object with all the parameters associated
     *   with the {@link javax.servlet.http.HttpServletRequest} used for creating the context.
     * 
     * 
     * @return the maps of request parameters.
     */
    public VariablesMap getRequestParameters();
    
    /**
     * 
     *   Returns a {@link VariablesMap} object with all the attributes associated
     *   with the {@link javax.servlet.http.HttpServletRequest} used for creating the context.
     * 
     * 
     * @return the maps of request attributes.
     */
    public VariablesMap getRequestAttributes();
    
    /**
     * 
     *   Returns a {@link VariablesMap} object with all the attributes associated
     *   with the {@link javax.servlet.http.HttpSession} object linked to the
     *   {@link javax.servlet.http.HttpServletRequest} used for creating the context.
     * 
     * 
     * @return the maps of session attributes.
     */
    public VariablesMap getSessionAttributes();
    
    /**
     * 
     *   Returns a {@link VariablesMap} object with all the attributes associated
     *   with the {@link ServletContext} object linked to the
     *   {@link javax.servlet.http.HttpServletRequest} used for creating the context.
     * 
     * 
     * @return the maps of application attributes.
     */
    public VariablesMap getApplicationAttributes();
    
}