Package org.apache.tiles.request.servlet
Class ServletRequest
java.lang.Object
org.apache.tiles.request.AbstractRequest
org.apache.tiles.request.AbstractClientRequest
org.apache.tiles.request.servlet.ServletRequest
- All Implemented Interfaces:
DispatchRequest
,Request
Servlet-based implementation of the TilesApplicationContext interface.
-
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
ConstructorsConstructorDescriptionServletRequest
(ApplicationContext applicationContext, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Creates a new instance of ServletTilesRequestContext. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Forwards to a path.void
Includes the result of a path.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.jakarta.servlet.http.HttpServletRequest
Return the preferred Locale in which the client will accept content.jakarta.servlet.http.HttpServletResponse
Return an Addable object that can be used to write headers to the response.Returns a writer to be used to write directly in the response.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.AbstractClientRequest
dispatch, getApplicationContext, getApplicationScope, include
Methods inherited from class org.apache.tiles.request.AbstractRequest
isForceInclude, setForceInclude
-
Constructor Details
-
ServletRequest
public ServletRequest(ApplicationContext applicationContext, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Creates a new instance of ServletTilesRequestContext.- Parameters:
applicationContext
- The application context.request
- The request object.response
- The response object.
-
-
Method Details
-
getHeader
Return an immutable Map that maps header names to the first (or only) header value (as a String).- Returns:
- The header map.
-
getResponseHeaders
Return an Addable object that can be used to write headers to the response.- Returns:
- An Addable object.
-
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.- Returns:
- The header values map.
-
getParam
Return an immutable Map that maps request parameter names to the first (or only) value (as a String).- Returns:
- The parameter map.
-
getParamValues
Return an immutable Map that maps request parameter names to the set of all values (as a String array).- Returns:
- The parameter values map.
-
getContext
Description copied from interface:Request
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.- Parameters:
scope
- The name of the scope.- Returns:
- The context.
-
getRequestScope
-
getSessionScope
-
getAvailableScopes
Description copied from interface:Request
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.- Returns:
- All the available scopes.
-
doForward
Forwards to a path.- Specified by:
doForward
in classAbstractClientRequest
- Parameters:
path
- The path to forward to.- Throws:
IOException
- If something goes wrong when forwarding.
-
doInclude
Includes the result of a path.- Specified by:
doInclude
in classAbstractClientRequest
- Parameters:
path
- The path to forward to.- Throws:
IOException
- If something goes wrong when forwarding.
-
getOutputStream
Returns an output stream to be used to write directly in the response.- 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.- 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.- 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.- Returns:
true
only if the response has been committed.
-
setContentType
Sets the content type when rendering the result.- Parameters:
contentType
- The content type. It should follow the specifications from W3C about content types.
-
getRequestLocale
Return the preferred Locale in which the client will accept content.- 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.
-
getRequest
public jakarta.servlet.http.HttpServletRequest getRequest() -
getResponse
public jakarta.servlet.http.HttpServletResponse getResponse() -
isUserInRole
Determine whether the specified user is in the given role.- Parameters:
role
- the role to check against.- Returns:
true
if the user is in the given role.
-