|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tiles.request.AbstractRequest
org.apache.tiles.request.AbstractClientRequest
org.apache.tiles.request.servlet.ServletRequest
public class ServletRequest
Servlet-based implementation of the TilesApplicationContext interface.
Field Summary |
---|
Fields inherited from class org.apache.tiles.request.AbstractRequest |
---|
FORCE_INCLUDE_ATTRIBUTE_NAME |
Constructor Summary | |
---|---|
ServletRequest(ApplicationContext applicationContext,
HttpServletRequest request,
HttpServletResponse response)
Creates a new instance of ServletTilesRequestContext. |
Method Summary | |
---|---|
void |
doForward(String path)
Forwards to a path. |
void |
doInclude(String path)
Includes the result of a path. |
List<String> |
getAvailableScopes()
Returns all available scopes, that are the ones returned by #getNativeScopes() plus derivative scopes (e.g. |
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. |
HttpServletRequest |
getRequest()
|
Locale |
getRequestLocale()
Return the preferred Locale in which the client will accept content. |
Map<String,Object> |
getRequestScope()
|
HttpServletResponse |
getResponse()
|
Addable<String> |
getResponseHeaders()
Return an Addable object that can be used to write headers to the response. |
Map<String,Object> |
getSessionScope()
|
Writer |
getWriter()
Returns a writer to be used to write directly in the response. |
boolean |
isResponseCommitted()
Checks if the response has been committed. |
boolean |
isUserInRole(String role)
Determine whether or not 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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServletRequest(ApplicationContext applicationContext, HttpServletRequest request, HttpServletResponse response)
applicationContext
- The application context.request
- The request object.response
- The response object.Method Detail |
---|
public Map<String,String> getHeader()
public Addable<String> getResponseHeaders()
public Map<String,String[]> getHeaderValues()
public Map<String,String> getParam()
public Map<String,String[]> getParamValues()
public Map<String,Object> getContext(String scope)
Request
scope
- The name of the scope.
public Map<String,Object> getRequestScope()
public Map<String,Object> getSessionScope()
public List<String> getAvailableScopes()
Request
#getNativeScopes()
plus derivative scopes (e.g. flash scope).
public void doForward(String path) throws IOException
doForward
in class AbstractClientRequest
path
- The path to forward to.
IOException
- If something goes wrong when forwarding.public void doInclude(String path) throws IOException
doInclude
in class AbstractClientRequest
path
- The path to forward to.
IOException
- If something goes wrong when forwarding.public OutputStream getOutputStream() throws IOException
IOException
- If something goes wrong when getting the output stream.public Writer getWriter() throws IOException
IOException
- If something goes wrong when getting the writer.public PrintWriter getPrintWriter() throws IOException
IOException
- If something goes wrong when getting the print
writer.public boolean isResponseCommitted()
true
only if the response has been committed.public void setContentType(String contentType)
contentType
- The content type. It should follow the specifications
from W3C about content types.public Locale getRequestLocale()
org.apache.tiles.locale.LocaleResolver
to implement strategies to
resolve locales.public HttpServletRequest getRequest()
public HttpServletResponse getResponse()
public boolean isUserInRole(String role)
role
- the role to check against.
true
if the user is in the given role.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |