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:
- DispatchRequest,- Request,- RequestWrapper
The implementation of the Tiles request context specific for Velocity.
- 
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 SummaryConstructorsConstructorDescriptionVelocityRequest(DispatchRequest enclosedRequest, org.apache.velocity.context.Context ctx, Writer writer) Constructor.
- 
Method SummaryModifier and TypeMethodDescriptionstatic VelocityRequestcreateVelocityRequest(ApplicationContext applicationContext, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.apache.velocity.context.Context velocityContext, Writer writer) Factory method to create a Velocity request.protected voidIncludes the result.Returns all available scopes.getContext(String scope) Returns a context map, given the scope name.Returns the page scope.Returns a print writer to be used to write directly in the response.Returns a writer to be used to write directly in the response.Methods inherited from class org.apache.tiles.request.AbstractViewRequestdispatch, includeMethods inherited from class org.apache.tiles.request.DispatchRequestWrappergetApplicationContext, getHeader, getHeaderValues, getOutputStream, getParam, getParamValues, getRequestLocale, getResponseHeaders, getWrappedRequest, isResponseCommitted, isUserInRole, setContentTypeMethods inherited from class org.apache.tiles.request.AbstractRequestisForceInclude, setForceInclude
- 
Constructor Details- 
VelocityRequestpublic VelocityRequest(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 Details- 
createVelocityRequestpublic static VelocityRequest createVelocityRequest(ApplicationContext applicationContext, jakarta.servlet.http.HttpServletRequest request, jakarta.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.
 
- 
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.
 
- 
doIncludeIncludes the result. By default, uses the wrapped request for the inclusion.- Overrides:
- doIncludein class- AbstractViewRequest
- Parameters:
- path- The path whose result will be included.
- Throws:
- IOException- If something goes wrong.
 
- 
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.
 
- 
getPageScopeReturns the page scope.- Returns:
- The page scope.
 
- 
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.
 
 
-