Class FreemarkerRequest
java.lang.Object
org.apache.tiles.request.AbstractRequest
org.apache.tiles.request.DispatchRequestWrapper
org.apache.tiles.request.AbstractViewRequest
org.apache.tiles.request.freemarker.FreemarkerRequest
- All Implemented Interfaces:
- DispatchRequest,- Request,- RequestWrapper
The FreeMarker-specific request context.
- 
Field SummaryFields inherited from class org.apache.tiles.request.AbstractRequestFORCE_INCLUDE_ATTRIBUTE_NAMEFields inherited from interface org.apache.tiles.request.RequestAPPLICATION_SCOPE, REQUEST_SCOPE
- 
Constructor SummaryConstructorsConstructorDescriptionFreemarkerRequest(DispatchRequest enclosedRequest, freemarker.core.Environment env) Constructor.
- 
Method SummaryModifier and TypeMethodDescriptionstatic FreemarkerRequestcreateServletFreemarkerRequest(ApplicationContext applicationContext, freemarker.core.Environment env) Creates a new Freemarker request.Returns all available scopes.getContext(String scope) Returns a context map, given the scope name.freemarker.core.EnvironmentReturns the environment object.Returns the page scope.Returns a print writer to be used to write directly in the response.Return the preferred Locale in which the client will accept content.Returns a writer to be used to write directly in the response.Methods inherited from class org.apache.tiles.request.AbstractViewRequestdispatch, doInclude, includeMethods inherited from class org.apache.tiles.request.DispatchRequestWrappergetApplicationContext, getHeader, getHeaderValues, getOutputStream, getParam, getParamValues, getResponseHeaders, getWrappedRequest, isResponseCommitted, isUserInRole, setContentTypeMethods inherited from class org.apache.tiles.request.AbstractRequestisForceInclude, setForceInclude
- 
Constructor Details- 
FreemarkerRequestConstructor.- Parameters:
- enclosedRequest- The request that exposes non-FreeMarker specific properties
- env- The FreeMarker environment.
 
 
- 
- 
Method Details- 
createServletFreemarkerRequestpublic static FreemarkerRequest createServletFreemarkerRequest(ApplicationContext applicationContext, freemarker.core.Environment env) Creates a new Freemarker request.- Parameters:
- applicationContext- The application context.
- env- The Freemarker environment object.
- Returns:
- A new request.
 
- 
getEnvironmentpublic freemarker.core.Environment getEnvironment()Returns the environment object.- Returns:
- The environment.
 
- 
getRequestLocaleReturn the preferred Locale in which the client will accept content.- Specified by:
- getRequestLocalein interface- Request
- Overrides:
- getRequestLocalein class- DispatchRequestWrapper
- Returns:
- The current request locale. It is the locale of the request
 object itself, and it is NOT the locale that the user wants to use. See
 LocaleResolverto implement strategies to resolve locales.
 
- 
getPageScopeReturns the page scope.- Returns:
- The page scope.
 
- 
getAvailableScopesDescription copied from class:DispatchRequestWrapperReturns all available scopes. The scopes are ordered according to their lifetime, the innermost, shorter lived scope appears first, and the outermost, longer lived scope appears last. Besides, the scopes "request" and "application" always included in the list.- Specified by:
- getAvailableScopesin interface- Request
- Overrides:
- getAvailableScopesin class- DispatchRequestWrapper
- Returns:
- All the available scopes.
 
- 
getPrintWriterReturns a print writer to be used to write directly in the response.- Specified by:
- getPrintWriterin interface- Request
- Overrides:
- getPrintWriterin class- DispatchRequestWrapper
- Returns:
- The print writer that writes in the response.
 
- 
getWriterReturns a writer to be used to write directly in the response.- Specified by:
- getWriterin interface- Request
- Overrides:
- getWriterin class- DispatchRequestWrapper
- Returns:
- The writer that writes in the response.
 
- 
getContextDescription copied from class:DispatchRequestWrapperReturns a context map, given the scope name. This method always return a map for all the scope names returned by getAvailableScopes(). That map may be writable, or immutable, depending on the implementation.- Specified by:
- getContextin interface- Request
- Overrides:
- getContextin class- DispatchRequestWrapper
- Parameters:
- scope- The name of the scope.
- Returns:
- The context.
 
 
-