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 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
Dispatches 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.void
Includes the response from the specified URL in the current response output.boolean
Checks if the response has been committed.boolean
isUserInRole
(String role) Determine whether the specified user is in the given role.void
setContentType
(String contentType) Sets the content type when rendering the result.Methods inherited from class org.apache.tiles.request.AbstractRequest
isForceInclude, setForceInclude
-
Constructor Details
-
DispatchRequestWrapper
Constructor.- Parameters:
context
- The request context to wrap.
-
-
Method Details
-
getWrappedRequest
Returns the wrapped Tiles request.- Specified by:
getWrappedRequest
in interfaceRequestWrapper
- Returns:
- The wrapped Tiles request.
-
getHeader
Return an immutable Map that maps header names to the first (or only) header value (as a String). -
getHeaderValues
Return 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:
getHeaderValues
in interfaceRequest
- Returns:
- The header values map.
-
getResponseHeaders
Return an Addable object that can be used to write headers to the response.- Specified by:
getResponseHeaders
in interfaceRequest
- Returns:
- An Addable object.
-
getContext
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 interfaceRequest
- Parameters:
scope
- The name of the scope.- Returns:
- The context.
-
getAvailableScopes
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 interfaceRequest
- Returns:
- All the available scopes.
-
getApplicationContext
Returns the associated application context.- Specified by:
getApplicationContext
in interfaceRequest
- Returns:
- The application context associated to this request.
-
dispatch
Dispatches the request to a specified path.- Specified by:
dispatch
in interfaceDispatchRequest
- Parameters:
path
- The path to dispatch to.- Throws:
IOException
- If something goes wrong during dispatching.
-
include
Includes the response from the specified URL in the current response output.- Specified by:
include
in interfaceDispatchRequest
- Parameters:
path
- The path to include.- Throws:
IOException
- If something goes wrong during inclusion.
-
getOutputStream
Returns an output stream to be used to write directly in the response.- Specified by:
getOutputStream
in interfaceRequest
- Returns:
- The output stream that writes in the response.
- Throws:
IOException
- If something goes wrong when getting the output stream.
-
getWriter
Returns a writer to be used to write directly in the response.- Specified by:
getWriter
in interfaceRequest
- Returns:
- The writer that writes in the response.
- Throws:
IOException
- If something goes wrong when getting the writer.
-
getPrintWriter
Returns a print writer to be used to write directly in the response.- Specified by:
getPrintWriter
in interfaceRequest
- Returns:
- The print writer that writes in the response.
- Throws:
IOException
- If something goes wrong when getting the print writer.
-
isResponseCommitted
public boolean isResponseCommitted()Checks if the response has been committed.- Specified by:
isResponseCommitted
in interfaceRequest
- Returns:
true
only if the response has been committed.
-
setContentType
Sets the content type when rendering the result.- Specified by:
setContentType
in interfaceDispatchRequest
- Parameters:
contentType
- The content type. It should follow the specifications from W3C about content types.
-
getParam
Return an immutable Map that maps request parameter names to the first (or only) value (as a String). -
getParamValues
Return an immutable Map that maps request parameter names to the set of all values (as a String array).- Specified by:
getParamValues
in interfaceRequest
- Returns:
- The parameter values map.
-
getRequestLocale
Return the preferred Locale in which the client will accept content.- Specified by:
getRequestLocale
in interfaceRequest
- 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
LocaleResolver
to implement strategies to resolve locales.
-
isUserInRole
Determine whether the specified user is in the given role.- Specified by:
isUserInRole
in interfaceRequest
- Parameters:
role
- the role to check against.- Returns:
true
if the user is in the given role.
-