WebContext (thymeleaf 1.1.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.thymeleaf.context
Class WebContext

Object
  org.thymeleaf.context.AbstractContext
      org.thymeleaf.context.WebContext

All Implemented Interfaces:: IContext, IWebContext

public class WebContext
extends AbstractContext
implements IWebContext
extends AbstractContext
implements IWebContext

Standard implementation for the IWebContext interface.

This IContext implementation uses a WebContextExecutionInfo object as its IContextExecutionInfo implementation.

Since:: 1.0
Author:: Daniel Fernández

Field Summary
`static String`	`APPLICATION_VARIABLE_NAME` Name of the context variable that contains the application (servlet context) attributes.
`static String`	`PARAM_VARIABLE_NAME` Name of the context variable that contains the request parameters.
`static String`	`SESSION_VARIABLE_NAME` Name of the context variable that contains the session attributes.

Fields inherited from class org.thymeleaf.context.AbstractContext
`EXEC_INFO_VARIABLE_NAME`

Constructor Summary
`WebContext(javax.servlet.http.HttpServletRequest request)` Create an instance without specifying a locale.
`WebContext(javax.servlet.http.HttpServletRequest request, Locale locale)` Create an instance specifying a locale.
`WebContext(javax.servlet.http.HttpServletRequest request, Locale locale, Map<String,?> variables)` Create an instance specifying a locale and an initial set of context variables.

Method Summary
`protected IContextExecutionInfo`	`buildContextExecutionInfo(String templateName)` Creates the specific instance of `IContextExecutionInfo` to be added to the context as the `execInfo` variable.
`VariablesMap<String,Object>`	`getApplicationAttributes()` Returns a `VariablesMap` object with all the attributes associated with the `ServletContext` object linked to the `HttpServletRequest` used for creating the context.
`String`	`getContextPath()` Returns the context path associated with the web application.
`javax.servlet.http.HttpServletRequest`	`getHttpServletRequest()` Returns the `HttpServletRequest` object associated with the request this context has been created for.
`javax.servlet.http.HttpSession`	`getHttpSession()` Returns the `HttpSession` object associated with the request this context has been created for.
`VariablesMap<String,Object>`	`getRequestAttributes()` Returns a `VariablesMap` object with all the attributes associated with the `HttpServletRequest` used for creating the context.
`VariablesMap<String,String[]>`	`getRequestParameters()` Returns a `VariablesMap` object with all the parameters associated with the `HttpServletRequest` used for creating the context.
`javax.servlet.ServletContext`	`getServletContext()` Returns the `ServletContext` object associated with the web application.
`VariablesMap<String,Object>`	`getSessionAttributes()` Returns a `VariablesMap` object with all the attributes associated with the `HttpSession` object linked to the `HttpServletRequest` used for creating the context.
`String`	`getSessionID()` Returns the session ID associated with the current execution of the template engine.
`boolean`	`isSessionIdFromCookie()` Returns whether the session ID is currently being kept by using cookies or an URL fragment.

Methods inherited from class org.thymeleaf.context.AbstractContext
`addContextExecutionInfo, clearVariables, getLocale, getVariables, setLocale, setVariable, setVariables`

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.thymeleaf.context.IContext
`addContextExecutionInfo, getLocale, getVariables`

Field Detail

PARAM_VARIABLE_NAME

public static final String PARAM_VARIABLE_NAME

Name of the context variable that contains the request parameters.

See Also:: Constant Field Values

SESSION_VARIABLE_NAME

public static final String SESSION_VARIABLE_NAME

Name of the context variable that contains the session attributes.

See Also:: Constant Field Values

APPLICATION_VARIABLE_NAME

public static final String APPLICATION_VARIABLE_NAME

Name of the context variable that contains the application (servlet context) attributes.

See Also:: Constant Field Values

Constructor Detail

WebContext

public WebContext(javax.servlet.http.HttpServletRequest request)

Create an instance without specifying a locale. Using this constructor, the default locale (Locale.getDefault()) will be used.

Parameters:: request - the HttpServletRequest that this context will be related to.

WebContext

public WebContext(javax.servlet.http.HttpServletRequest request,
                  Locale locale)

Create an instance specifying a locale.

Parameters:: request - the HttpServletRequest that this context will be related to.; locale - the locale to be used.

WebContext

public WebContext(javax.servlet.http.HttpServletRequest request,
                  Locale locale,
                  Map<String,?> variables)

Create an instance specifying a locale and an initial set of context variables.

Parameters:: request - the HttpServletRequest that this context will be related to.; locale - the locale to be used.; variables - the initial set of context variables.

Method Detail