org.apache.tiles.request.velocity

Class VelocityRequest

java.lang.Object

org.apache.tiles.request.AbstractRequest

org.apache.tiles.request.DispatchRequestWrapper

org.apache.tiles.request.AbstractViewRequest

org.apache.tiles.request.velocity.VelocityRequest

All Implemented Interfaces:

org.apache.tiles.request.DispatchRequest, org.apache.tiles.request.Request, org.apache.tiles.request.RequestWrapper

public class VelocityRequest
extends org.apache.tiles.request.AbstractViewRequest

The implementation of the Tiles request context specific for Velocity.

Version:

$Rev: 1332186 $ $Date: 2012-04-30 23:20:15 +1000 (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

Constructors

Constructor and Description
VelocityRequest(org.apache.tiles.request.DispatchRequest enclosedRequest, org.apache.velocity.context.Context ctx, Writer writer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static VelocityRequest	createVelocityRequest(org.apache.tiles.request.ApplicationContext applicationContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context velocityContext, Writer writer) Factory method to create a Velocity request.
protected void	doInclude(String path)
List<String>	getAvailableScopes()
Map<String,Object>	getContext(String scope)
Map<String,Object>	getPageScope() Returns the page scope.
PrintWriter	getPrintWriter()
Writer	getWriter()

Methods inherited from class org.apache.tiles.request.AbstractViewRequest

dispatch, include

Methods inherited from class org.apache.tiles.request.DispatchRequestWrapper

getApplicationContext, getHeader, getHeaderValues, getOutputStream, getParam, getParamValues, getRequestLocale, 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

VelocityRequest

public VelocityRequest(org.apache.tiles.request.DispatchRequest enclosedRequest,
               org.apache.velocity.context.Context ctx,
               Writer writer)

Constructor.

Parameters:

enclosedRequest - The request that exposes non-Velocity specific properties

ctx - The Velocity current context.

writer - The writer to use to render the response. It may be null, if not necessary.

Method Detail

createVelocityRequest

public static VelocityRequest createVelocityRequest(org.apache.tiles.request.ApplicationContext applicationContext,
                                    javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    org.apache.velocity.context.Context velocityContext,
                                    Writer writer)

Factory method to create a Velocity request.

Parameters:

applicationContext - The application context.

request - The request.

response - The response.

velocityContext - The Velocity context.

writer - The writer to write into.

Returns:

The request.

getAvailableScopes

public List<String> getAvailableScopes()

Specified by:

getAvailableScopes in interface org.apache.tiles.request.Request

Overrides:

getAvailableScopes in class org.apache.tiles.request.DispatchRequestWrapper

doInclude

protected void doInclude(String path)
                  throws IOException

Overrides:

doInclude in class org.apache.tiles.request.AbstractViewRequest

Throws:

IOException

getPrintWriter

public PrintWriter getPrintWriter()

Specified by:

getPrintWriter in interface org.apache.tiles.request.Request

Overrides:

getPrintWriter in class org.apache.tiles.request.DispatchRequestWrapper

getWriter

public Writer getWriter()

Specified by:

getWriter in interface org.apache.tiles.request.Request

Overrides:

getWriter in class org.apache.tiles.request.DispatchRequestWrapper

getPageScope

public Map<String,Object> getPageScope()

Returns the page scope.

Returns:

The page scope.

getContext

public Map<String,Object> getContext(String scope)

Specified by:

getContext in interface org.apache.tiles.request.Request

Overrides:

getContext in class org.apache.tiles.request.DispatchRequestWrapper