public class DispatchRequestWrapper extends AbstractRequest implements RequestWrapper
FORCE_INCLUDE_ATTRIBUTE_NAMEAPPLICATION_SCOPE, REQUEST_SCOPE| Constructor and Description | 
|---|
| DispatchRequestWrapper(DispatchRequest context)Constructor. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | dispatch(String path)Dispatches the request to a specified path. | 
| ApplicationContext | getApplicationContext()Returns the associated application context. | 
| List<String> | getAvailableScopes()Returns all available scopes. | 
| Map<String,Object> | getContext(String scope)Returns a context map, given the scope name. | 
| Map<String,String> | getHeader()Return an immutable Map that maps header names to the first (or only)
 header value (as a String). | 
| Map<String,String[]> | getHeaderValues()Return an immutable Map that maps header names to the set of all values
 specified in the request (as a String array). | 
| OutputStream | getOutputStream()Returns an output stream to be used to write directly in the response. | 
| Map<String,String> | getParam()Return an immutable Map that maps request parameter names to the first
 (or only) value (as a String). | 
| Map<String,String[]> | getParamValues()Return an immutable Map that maps request parameter names to the set of
 all values (as a String array). | 
| PrintWriter | getPrintWriter()Returns a print writer to be used to write directly in the response. | 
| Locale | getRequestLocale()Return the preferred Locale in which the client will accept content. | 
| Addable<String> | getResponseHeaders()Return an Addable object that can be used to write headers to the response. | 
| DispatchRequest | getWrappedRequest()Returns the wrapped Tiles request. | 
| Writer | getWriter()Returns a writer to be used to write directly in the response. | 
| void | include(String path)Includes the response from the specified URL in the current response output. | 
| boolean | isResponseCommitted()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. | 
isForceInclude, setForceIncludepublic DispatchRequestWrapper(DispatchRequest context)
context - The request context to wrap.public DispatchRequest getWrappedRequest()
getWrappedRequest in interface RequestWrapperpublic Map<String,String> getHeader()
public Map<String,String[]> getHeaderValues()
getHeaderValues in interface Requestpublic Addable<String> getResponseHeaders()
getResponseHeaders in interface Requestpublic Map<String,Object> getContext(String scope)
getContext in interface Requestscope - The name of the scope.public List<String> getAvailableScopes()
getAvailableScopes in interface Requestpublic ApplicationContext getApplicationContext()
getApplicationContext in interface Requestpublic void dispatch(String path) throws IOException
dispatch in interface DispatchRequestpath - The path to dispatch to.IOException - If something goes wrong during dispatching.public void include(String path) throws IOException
include in interface DispatchRequestpath - The path to include.IOException - If something goes wrong during inclusion.public OutputStream getOutputStream() throws IOException
getOutputStream in interface RequestIOException - If something goes wrong when getting the output stream.public Writer getWriter() throws IOException
getWriter in interface RequestIOException - If something goes wrong when getting the writer.public PrintWriter getPrintWriter() throws IOException
getPrintWriter in interface RequestIOException - If something goes wrong when getting the print
 writer.public boolean isResponseCommitted()
isResponseCommitted in interface Requesttrue only if the response has been committed.public void setContentType(String contentType)
setContentType in interface DispatchRequestcontentType - The content type. It should follow the specifications
                    from W3C about content types.public Map<String,String> getParam()
public Map<String,String[]> getParamValues()
getParamValues in interface Requestpublic Locale getRequestLocale()
getRequestLocale in interface RequestLocaleResolver to implement strategies to
 resolve locales.public boolean isUserInRole(String role)
isUserInRole in interface Requestrole - the role to check against.true if the user is in the given role.Copyright © 2000–2025 Apache Software Foundation. All rights reserved.