org.apache.pluto.driver.core
Class PortalRequestContext

java.lang.Object
  extended by org.apache.pluto.driver.core.PortalRequestContext

public class PortalRequestContext
extends Object

Defines the context of the currentl portal request. Allows for the retrieval of the original request and response throughout the lifetime of the request. Provides a consistent interface for parsing/creating PortalURLs to the outside world.


Field Summary
static String REQUEST_KEY
          The attribute key to bind the portal environment instance to servlet request.
 
Constructor Summary
PortalRequestContext(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Creates a PortalRequestContext instance.
 
Method Summary
 PortalURL createPortalURL()
           
static PortalRequestContext getContext(javax.servlet.http.HttpServletRequest request)
          Returns the portal environment from the servlet request.
static String getREQUEST_KEY()
           
 javax.servlet.http.HttpServletRequest getRequest()
          Returns the servlet request.
 PortalURL getRequestedPortalURL()
          Returns the requested portal URL.
 javax.servlet.http.HttpServletResponse getResponse()
          Returns the servlet response.
 javax.servlet.ServletContext getServletContext()
           
 void setPortalURL(PortalURL portalURL)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REQUEST_KEY

public static final String REQUEST_KEY
The attribute key to bind the portal environment instance to servlet request.

Constructor Detail

PortalRequestContext

public PortalRequestContext(javax.servlet.ServletContext servletContext,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
Creates a PortalRequestContext instance.

Parameters:
request - the incoming servlet request.
response - the incoming servlet response.
Method Detail

getContext

public static PortalRequestContext getContext(javax.servlet.http.HttpServletRequest request)
Returns the portal environment from the servlet request. The portal envirionment instance is saved in the request scope.

Parameters:
request - the servlet request.
Returns:
the portal environment.

getRequest

public javax.servlet.http.HttpServletRequest getRequest()
Returns the servlet request.

Returns:
the servlet request.

getResponse

public javax.servlet.http.HttpServletResponse getResponse()
Returns the servlet response.

Returns:
the servlet response.

getRequestedPortalURL

public PortalURL getRequestedPortalURL()
Returns the requested portal URL.

Returns:
the requested portal URL.

createPortalURL

public PortalURL createPortalURL()

setPortalURL

public void setPortalURL(PortalURL portalURL)

getREQUEST_KEY

public static String getREQUEST_KEY()

getServletContext

public javax.servlet.ServletContext getServletContext()


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.