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

public class ServletRequest
extends AbstractClientRequest

Servlet-based implementation of the TilesApplicationContext interface.

Version:

$Rev: 1375743 $ $Date: 2012-08-22 06:05:58 +1000 (Wed, 22 Aug 2012) $

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

Constructor and Description
ServletRequest(ApplicationContext applicationContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates a new instance of ServletTilesRequestContext.

Method Summary

Methods

Modifier and Type	Method and Description
void	doForward(String path)
void	doInclude(String path)
List<String>	getAvailableScopes()
Map<String,Object>	getContext(String scope)
Map<String,String>	getHeader()
Map<String,String[]>	getHeaderValues()
OutputStream	getOutputStream()
Map<String,String>	getParam()
Map<String,String[]>	getParamValues()
PrintWriter	getPrintWriter()
javax.servlet.http.HttpServletRequest	getRequest()
Locale	getRequestLocale()
Map<String,Object>	getRequestScope()
javax.servlet.http.HttpServletResponse	getResponse()
Addable<String>	getResponseHeaders()
Map<String,Object>	getSessionScope()
Writer	getWriter()
boolean	isResponseCommitted()
boolean	isUserInRole(String role)
void	setContentType(String contentType)

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

ServletRequest

public ServletRequest(ApplicationContext applicationContext,
              javax.servlet.http.HttpServletRequest request,
              javax.servlet.http.HttpServletResponse response)

Creates a new instance of ServletTilesRequestContext.

Parameters:

applicationContext - The application context.

request - The request object.

response - The response object.

Method Detail

getHeader

public Map<String,String> getHeader()

getResponseHeaders

public Addable<String> getResponseHeaders()

getHeaderValues

public Map<String,String[]> getHeaderValues()

getParam

public Map<String,String> getParam()

getParamValues

public Map<String,String[]> getParamValues()

getContext

public Map<String,Object> getContext(String scope)

getRequestScope

public Map<String,Object> getRequestScope()

getSessionScope

public Map<String,Object> getSessionScope()

getAvailableScopes

public List<String> getAvailableScopes()

doForward

public void doForward(String path)
               throws IOException

Specified by:

doForward in class AbstractClientRequest

Throws:

IOException

doInclude

public void doInclude(String path)
               throws IOException

Specified by:

doInclude in class AbstractClientRequest

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Throws:

IOException

getWriter

public Writer getWriter()
                 throws IOException

Throws:

IOException

getPrintWriter

public PrintWriter getPrintWriter()
                           throws IOException

Throws:

IOException

isResponseCommitted

public boolean isResponseCommitted()

setContentType

public void setContentType(String contentType)

getRequestLocale

public Locale getRequestLocale()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

isUserInRole

public boolean isUserInRole(String role)