org.apache.tiles.request.portlet
Class PortletRequest

Package class diagram package PortletRequest
java.lang.Object
  extended by org.apache.tiles.request.AbstractRequest
      extended by org.apache.tiles.request.AbstractClientRequest
          extended by org.apache.tiles.request.portlet.PortletRequest
All Implemented Interfaces:
DispatchRequest, Request
Direct Known Subclasses:
ActionPortletRequest, EventPortletRequest, RenderPortletRequest, ResourcePortletRequest

public class PortletRequest
extends AbstractClientRequest

Portlet-based TilesApplicationContext implementation.

Version:
$Rev$ $Date$

Field Summary
protected  PortletContext context
          The PortletContext for this application.
protected  javax.portlet.PortletRequest request
          The PortletRequest for this request.
protected  RequestDelegate requestDelegate
          The delegate to get information about parameters.
protected  PortletResponse response
          The PortletResponse for this request.
protected  ResponseDelegate responseDelegate
          The delegate to get information from a response (output stream, writer, etc.).
 
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
PortletRequest(ApplicationContext applicationContext, PortletContext context, javax.portlet.PortletRequest request, PortletResponse response, RequestDelegate requestDelegate, ResponseDelegate responseDelegate)
          Creates a new instance of PortletTilesRequestContext.
 
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.
 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).
 PortletContext getPortletContext()
          Returns the portlet context.
 Map<String,Object> getPortletSessionScope()
          
 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.
 Map<String,Object> getRequestScope()
          
 PortletResponse getResponse()
          Return the PortletResponse for this context.
 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
 

Field Detail

context

protected PortletContext context
The PortletContext for this application.


request

protected javax.portlet.PortletRequest request

The PortletRequest for this request.


requestDelegate

protected RequestDelegate requestDelegate
The delegate to get information about parameters.


response

protected PortletResponse response

The PortletResponse for this request.


responseDelegate

protected ResponseDelegate responseDelegate
The delegate to get information from a response (output stream, writer, etc.).

Constructor Detail

PortletRequest

public PortletRequest(ApplicationContext applicationContext,
                      PortletContext context,
                      javax.portlet.PortletRequest request,
                      PortletResponse response,
                      RequestDelegate requestDelegate,
                      ResponseDelegate responseDelegate)
Creates a new instance of PortletTilesRequestContext.

Parameters:
applicationContext - The Tiles application context.
context - The portlet context to use.
request - The request object to use.
response - The response object to use.
requestDelegate - The request delegate.
responseDelegate - The response delegate.
Method Detail

getRequest

public javax.portlet.PortletRequest getRequest()

Return the PortletRequest for this context.

Returns:
The used portlet request.

getResponse

public PortletResponse getResponse()

Return the PortletResponse for this context.

Returns:
The used portlet response.

getPortletContext

public PortletContext getPortletContext()
Returns the portlet context.

Returns:
The portlet context.

getHeader

public Map<String,String> getHeader()
Return an immutable Map that maps header names to the first (or only) header value (as a String).

Returns:
The header map.

getResponseHeaders

public Addable<String> getResponseHeaders()
Return an Addable object that can be used to write headers to the response.

Returns:
An Addable object.

getHeaderValues

public 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). Header names must be matched in a case-insensitive manner.

Returns:
The header values map.

getRequestScope

public Map<String,Object> getRequestScope()


getSessionScope

public Map<String,Object> getSessionScope()


getPortletSessionScope

public Map<String,Object> getPortletSessionScope()


getAvailableScopes

public List<String> getAvailableScopes()
Description copied from interface: Request
Returns 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.

getRequestLocale

public Locale getRequestLocale()
Return 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 org.apache.tiles.locale.LocaleResolver to implement strategies to resolve locales.

getParam

public Map<String,String> getParam()
Description copied from interface: Request
Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

Returns:
The parameter map.

getParamValues

public Map<String,String[]> getParamValues()
Description copied from interface: Request
Return an immutable Map that maps request parameter names to the set of all values (as a String array).

Returns:
The parameter values map.

isUserInRole

public boolean isUserInRole(String role)
Determine whether or not the specified user is in the given role.

Parameters:
role - the role to check against.
Returns:
true if the user is in the given role.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException
Description copied from interface: Request
Returns 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.

getPrintWriter

public PrintWriter getPrintWriter()
                           throws IOException
Description copied from interface: Request
Returns 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.

getWriter

public Writer getWriter()
                 throws IOException
Description copied from interface: Request
Returns 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.

isResponseCommitted

public boolean isResponseCommitted()
Description copied from interface: Request
Checks if the response has been committed.

Returns:
true only if the response has been committed.

setContentType

public void setContentType(String contentType)
Description copied from interface: DispatchRequest
Sets the content type when rendering the result.

Parameters:
contentType - The content type. It should follow the specifications from W3C about content types.

doForward

public void doForward(String path)
               throws IOException
Forwards to a path.

Specified by:
doForward in class AbstractClientRequest
Parameters:
path - The path to forward to.
Throws:
IOException - If something goes wrong when forwarding.

doInclude

public void doInclude(String path)
               throws IOException
Includes the result of a path.

Specified by:
doInclude in class AbstractClientRequest
Parameters:
path - The path to forward to.
Throws:
IOException - If something goes wrong when forwarding.

getContext

public Map<String,Object> getContext(String scope)
Description copied from interface: Request
Returns 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.


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.