|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.tiles.context.TilesApplicationContextWrapper org.apache.tiles.portlet.context.PortletTilesRequestContext
public class PortletTilesRequestContext
Portlet-based TilesApplicationContext implementation.
Field Summary | |
---|---|
protected Map<String,String> |
param
The lazily instantiated Map of request
parameter name-value. |
protected Map<String,String[]> |
paramValues
The lazily instantiated Map of request
parameter name-values. |
protected javax.portlet.PortletRequest |
request
The PortletRequest for this request. |
protected javax.portlet.PortletResponse |
response
The PortletResponse for this request. |
Constructor Summary | |
---|---|
PortletTilesRequestContext(javax.portlet.PortletContext context,
javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
Deprecated. Use PortletTilesRequestContext(TilesApplicationContext, PortletContext, PortletRequest, PortletResponse)
. |
|
PortletTilesRequestContext(TilesApplicationContext applicationContext,
javax.portlet.PortletContext context,
javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
Creates a new instance of PortletTilesRequestContext. |
Method Summary | |
---|---|
void |
dispatch(String path)
Dispatches the request to a specified path. |
TilesApplicationContext |
getApplicationContext()
Returns the associated application context. |
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. |
javax.portlet.PortletRequest |
getRequest()
Return the PortletRequest for this context. |
Locale |
getRequestLocale()
Return the preferred Locale in which the client will accept content. |
Object[] |
getRequestObjects()
Returns the original request objects used to create this request. |
Map<String,Object> |
getRequestScope()
Return a mutable Map that maps request scope attribute names to their values. |
javax.portlet.PortletResponse |
getResponse()
Return the PortletResponse for this context. |
Map<String,Object> |
getSessionScope()
Return a mutable Map that maps session scope attribute names to their values. |
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. |
void |
initialize(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
Initialize (or reinitialize) this PortletTilesRequestContext instance
for the specified Portlet API objects. |
boolean |
isUserInRole(String role)
Determine whether or not the specified user is in the given role. |
void |
release()
Release references to allocated resources acquired in initialize() of via subsequent processing. |
Methods inherited from class org.apache.tiles.context.TilesApplicationContextWrapper |
---|
getApplicationScope, getContext, getInitParams, getResource, getResources, getWrappedApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected javax.portlet.PortletRequest request
The PortletRequest
for this request.
protected javax.portlet.PortletResponse response
The PortletResponse
for this request.
protected Map<String,String> param
The lazily instantiated Map
of request
parameter name-value.
protected Map<String,String[]> paramValues
The lazily instantiated Map
of request
parameter name-values.
Constructor Detail |
---|
public PortletTilesRequestContext(TilesApplicationContext applicationContext, javax.portlet.PortletContext context, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
applicationContext
- The Tiles application context.context
- The portlet context to use.request
- The request object to use.response
- The response object to use.@Deprecated public PortletTilesRequestContext(javax.portlet.PortletContext context, javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
PortletTilesRequestContext(TilesApplicationContext, PortletContext, PortletRequest, PortletResponse)
.
context
- The portlet context to use.request
- The request object to use.response
- The response object to use.Method Detail |
---|
public void initialize(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
Initialize (or reinitialize) this PortletTilesRequestContext
instance
for the specified Portlet API objects.
request
- The PortletRequest
for this requestresponse
- The PortletResponse
for this requestpublic void release()
Release references to allocated resources acquired in
initialize()
of via subsequent processing. After this
method is called, subsequent calls to any other method than
initialize()
will return undefined results.
public javax.portlet.PortletRequest getRequest()
Return the PortletRequest
for this context.
getRequest
in interface TilesRequestContext
public javax.portlet.PortletResponse getResponse()
Return the PortletResponse
for this context.
getResponse
in interface TilesRequestContext
public Map<String,String> getHeader()
getHeader
in interface TilesRequestContext
public Map<String,String[]> getHeaderValues()
getHeaderValues
in interface TilesRequestContext
public Map<String,String> getParam()
getParam
in interface TilesRequestContext
public Map<String,String[]> getParamValues()
getParamValues
in interface TilesRequestContext
public Map<String,Object> getRequestScope()
getRequestScope
in interface TilesRequestContext
public Map<String,Object> getSessionScope()
getSessionScope
in interface TilesRequestContext
public TilesApplicationContext getApplicationContext()
getApplicationContext
in interface TilesRequestContext
public void dispatch(String path) throws IOException
dispatch
in interface TilesRequestContext
path
- The path to dispatch to.
IOException
- If something goes wrong during dispatching.public void include(String path) throws IOException
include
in interface TilesRequestContext
path
- The path to include.
IOException
- If something goes wrong during inclusion.public OutputStream getOutputStream() throws IOException
getOutputStream
in interface TilesRequestContext
IOException
- If something goes wrong when getting the output stream.public PrintWriter getPrintWriter() throws IOException
getPrintWriter
in interface TilesRequestContext
IOException
- If something goes wrong when getting the print
writer.public Writer getWriter() throws IOException
getWriter
in interface TilesRequestContext
IOException
- If something goes wrong when getting the writer.public Object[] getRequestObjects()
getRequestObjects
in interface TilesRequestContext
public Locale getRequestLocale()
getRequestLocale
in interface TilesRequestContext
LocaleResolver
to implement strategies to
resolve locales.public boolean isUserInRole(String role)
isUserInRole
in interface TilesRequestContext
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 |