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 SummaryFields inherited from class org.apache.tiles.request.AbstractRequestFORCE_INCLUDE_ATTRIBUTE_NAMEFields inherited from interface org.apache.tiles.request.RequestAPPLICATION_SCOPE, REQUEST_SCOPE
- 
Constructor SummaryConstructorsConstructorDescriptionServletRequest(ApplicationContext applicationContext, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) Creates a new instance of ServletTilesRequestContext.
- 
Method SummaryModifier and TypeMethodDescriptionvoidForwards to a path.voidIncludes 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.HttpServletRequestReturn the preferred Locale in which the client will accept content.jakarta.servlet.http.HttpServletResponseReturn 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.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.AbstractClientRequestdispatch, getApplicationContext, getApplicationScope, includeMethods inherited from class org.apache.tiles.request.AbstractRequestisForceInclude, setForceInclude
- 
Constructor Details- 
ServletRequestpublic 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- 
getHeaderReturn an immutable Map that maps header names to the first (or only) header value (as a String).- Returns:
- The header map.
 
- 
getResponseHeadersReturn an Addable object that can be used to write headers to the response.- Returns:
- An Addable object.
 
- 
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.- Returns:
- The header values map.
 
- 
getParamReturn an immutable Map that maps request parameter names to the first (or only) value (as a String).- Returns:
- The parameter map.
 
- 
getParamValuesReturn an immutable Map that maps request parameter names to the set of all values (as a String array).- Returns:
- The parameter values map.
 
- 
getContextDescription copied from interface:RequestReturns 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
- 
getAvailableScopesDescription copied from interface:RequestReturns 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.
 
- 
doForwardForwards to a path.- Specified by:
- doForwardin class- AbstractClientRequest
- Parameters:
- path- The path to forward to.
- Throws:
- IOException- If something goes wrong when forwarding.
 
- 
doIncludeIncludes the result of a path.- Specified by:
- doIncludein class- AbstractClientRequest
- Parameters:
- path- The path to forward to.
- Throws:
- IOException- If something goes wrong when forwarding.
 
- 
getOutputStreamReturns 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.
 
- 
getWriterReturns 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.
 
- 
getPrintWriterReturns 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.
 
- 
isResponseCommittedpublic boolean isResponseCommitted()Checks if the response has been committed.- Returns:
- trueonly if the response has been committed.
 
- 
setContentTypeSets the content type when rendering the result.- Parameters:
- contentType- The content type. It should follow the specifications from W3C about content types.
 
- 
getRequestLocaleReturn 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
 LocaleResolverto implement strategies to resolve locales.
 
- 
getRequestpublic jakarta.servlet.http.HttpServletRequest getRequest()
- 
getResponsepublic jakarta.servlet.http.HttpServletResponse getResponse()
- 
isUserInRoleDetermine whether the specified user is in the given role.- Parameters:
- role- the role to check against.
- Returns:
- trueif the user is in the given role.
 
 
-