Package org.apache.tiles.request
Class DispatchRequestWrapper
java.lang.Object
org.apache.tiles.request.AbstractRequest
org.apache.tiles.request.DispatchRequestWrapper
- All Implemented Interfaces:
- DispatchRequest,- Request,- RequestWrapper
- Direct Known Subclasses:
- AbstractViewRequest
Delegate for ease of customization.
- 
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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidDispatches the request to a specified path.Returns the associated application context.Returns all available scopes.getContext(String scope) Returns a context map, given the scope name.Return an immutable Map that maps header names to the first (or only) header value (as a String).Return an immutable Map that maps header names to the set of all values specified in the request (as a String array).Returns an output stream to be used to write directly in the response.getParam()Return an immutable Map that maps request parameter names to the first (or only) value (as a String).Return an immutable Map that maps request parameter names to the set of all values (as a String array).Returns a print writer to be used to write directly in the response.Return the preferred Locale in which the client will accept content.Return an Addable object that can be used to write headers to the response.Returns the wrapped Tiles request.Returns a writer to be used to write directly in the response.voidIncludes the response from the specified URL in the current response output.booleanChecks if the response has been committed.booleanisUserInRole(String role) Determine whether the specified user is in the given role.voidsetContentType(String contentType) Sets the content type when rendering the result.Methods inherited from class org.apache.tiles.request.AbstractRequestisForceInclude, setForceInclude
- 
Constructor Details- 
DispatchRequestWrapperConstructor.- Parameters:
- context- The request context to wrap.
 
 
- 
- 
Method Details- 
getWrappedRequestReturns the wrapped Tiles request.- Specified by:
- getWrappedRequestin interface- RequestWrapper
- Returns:
- The wrapped Tiles request.
 
- 
getHeaderReturn an immutable Map that maps header names to the first (or only) header value (as a String).
- 
getHeaderValuesReturn an immutable Map that maps header names to the set of all values specified in the request (as a String array). Header names must be matched in a case-insensitive manner.- Specified by:
- getHeaderValuesin interface- Request
- Returns:
- The header values map.
 
- 
getResponseHeadersReturn an Addable object that can be used to write headers to the response.- Specified by:
- getResponseHeadersin interface- Request
- Returns:
- An Addable object.
 
- 
getContextReturns 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
- Parameters:
- scope- The name of the scope.
- Returns:
- The context.
 
- 
getAvailableScopesReturns 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
- Returns:
- All the available scopes.
 
- 
getApplicationContextReturns the associated application context.- Specified by:
- getApplicationContextin interface- Request
- Returns:
- The application context associated to this request.
 
- 
dispatchDispatches the request to a specified path.- Specified by:
- dispatchin interface- DispatchRequest
- Parameters:
- path- The path to dispatch to.
- Throws:
- IOException- If something goes wrong during dispatching.
 
- 
includeIncludes the response from the specified URL in the current response output.- Specified by:
- includein interface- DispatchRequest
- Parameters:
- path- The path to include.
- Throws:
- IOException- If something goes wrong during inclusion.
 
- 
getOutputStreamReturns an output stream to be used to write directly in the response.- Specified by:
- getOutputStreamin interface- Request
- Returns:
- The output stream that writes in the response.
- Throws:
- IOException- If something goes wrong when getting the output stream.
 
- 
getWriterReturns a writer to be used to write directly in the response.- Specified by:
- getWriterin interface- Request
- Returns:
- The writer that writes in the response.
- Throws:
- IOException- If something goes wrong when getting the writer.
 
- 
getPrintWriterReturns a print writer to be used to write directly in the response.- Specified by:
- getPrintWriterin interface- Request
- Returns:
- The print writer that writes in the response.
- Throws:
- IOException- If something goes wrong when getting the print writer.
 
- 
isResponseCommittedpublic boolean isResponseCommitted()Checks if the response has been committed.- Specified by:
- isResponseCommittedin interface- Request
- Returns:
- trueonly if the response has been committed.
 
- 
setContentTypeSets the content type when rendering the result.- Specified by:
- setContentTypein interface- DispatchRequest
- Parameters:
- contentType- The content type. It should follow the specifications from W3C about content types.
 
- 
getParamReturn an immutable Map that maps request parameter names to the first (or only) value (as a String).
- 
getParamValuesReturn an immutable Map that maps request parameter names to the set of all values (as a String array).- Specified by:
- getParamValuesin interface- Request
- Returns:
- The parameter values map.
 
- 
getRequestLocaleReturn the preferred Locale in which the client will accept content.- Specified by:
- getRequestLocalein interface- Request
- 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.
 
- 
isUserInRoleDetermine whether the specified user is in the given role.- Specified by:
- isUserInRolein interface- Request
- Parameters:
- role- the role to check against.
- Returns:
- trueif the user is in the given role.
 
 
-