org.apache.tiles.request.freemarker
Class FreemarkerRequest

Package class diagram package FreemarkerRequest
java.lang.Object
  extended by org.apache.tiles.request.AbstractRequest
      extended by org.apache.tiles.request.DispatchRequestWrapper
          extended by org.apache.tiles.request.AbstractViewRequest
              extended by org.apache.tiles.request.freemarker.FreemarkerRequest
All Implemented Interfaces:
DispatchRequest, Request, RequestWrapper

public class FreemarkerRequest
extends AbstractViewRequest

The FreeMarker-specific request context.

Version:
$Rev: 1332186 $ $Date: 2012-04-30 09:20:15 -0400 (Mon, 30 Apr 2012) $

Field Summary
 
Fields inherited from class org.apache.tiles.request.AbstractRequest
FORCE_INCLUDE_ATTRIBUTE_NAME
 
Fields inherited from interface org.apache.tiles.request.Request
APPLICATION_SCOPE, REQUEST_SCOPE
 
Constructor Summary
FreemarkerRequest(DispatchRequest enclosedRequest, Environment env)
          Constructor.
 
Method Summary
static FreemarkerRequest createServletFreemarkerRequest(ApplicationContext applicationContext, Environment env)
          Creates a new Freemarker request.
 List<String> getAvailableScopes()
          Returns all available scopes.
 Map<String,Object> getContext(String scope)
          Returns a context map, given the scope name.
 Environment getEnvironment()
          Returns the environment object.
 Map<String,Object> getPageScope()
          Returns the page scope.
 PrintWriter getPrintWriter()
          Returns a print writer to be used to write directly in the response.
 Locale getRequestLocale()
          Return the preferred Locale in which the client will accept content.
 Writer getWriter()
          Returns a writer to be used to write directly in the response.
 
Methods inherited from class org.apache.tiles.request.AbstractViewRequest
dispatch, doInclude, include
 
Methods inherited from class org.apache.tiles.request.DispatchRequestWrapper
getApplicationContext, getHeader, getHeaderValues, getOutputStream, getParam, getParamValues, getResponseHeaders, getWrappedRequest, isResponseCommitted, isUserInRole, setContentType
 
Methods inherited from class org.apache.tiles.request.AbstractRequest
isForceInclude, setForceInclude
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FreemarkerRequest

public FreemarkerRequest(DispatchRequest enclosedRequest,
                         Environment env)
Constructor.

Parameters:
enclosedRequest - The request that exposes non-FreeMarker specific properties
env - The FreeMarker environment.
Method Detail

createServletFreemarkerRequest

public static FreemarkerRequest createServletFreemarkerRequest(ApplicationContext applicationContext,
                                                               Environment env)
Creates a new Freemarker request.

Parameters:
applicationContext - The application context.
env - The Freemarker's environment object.
Returns:
A new request.

getEnvironment

public Environment getEnvironment()
Returns the environment object.

Returns:
The environment.

getRequestLocale

public Locale getRequestLocale()
Return the preferred Locale in which the client will accept content.

Specified by:
getRequestLocale in interface Request
Overrides:
getRequestLocale in 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 org.apache.tiles.locale.LocaleResolver to implement strategies to resolve locales.

getPageScope

public Map<String,Object> getPageScope()
Returns the page scope.

Returns:
The page scope.

getAvailableScopes

public List<String> getAvailableScopes()
Description copied from class: DispatchRequestWrapper
Returns 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:
getAvailableScopes in interface Request
Overrides:
getAvailableScopes in class DispatchRequestWrapper
Returns:
All the available scopes.

getPrintWriter

public PrintWriter getPrintWriter()
Returns a print writer to be used to write directly in the response.

Specified by:
getPrintWriter in interface Request
Overrides:
getPrintWriter in class DispatchRequestWrapper
Returns:
The print writer that writes in the response.

getWriter

public Writer getWriter()
Returns a writer to be used to write directly in the response.

Specified by:
getWriter in interface Request
Overrides:
getWriter in class DispatchRequestWrapper
Returns:
The writer that writes in the response.

getContext

public Map<String,Object> getContext(String scope)
Description copied from class: DispatchRequestWrapper
Returns 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:
getContext in interface Request
Overrides:
getContext in class DispatchRequestWrapper
Parameters:
scope - The name of the scope.
Returns:
The context.


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.