com.frameworkset.platform.cms.driver.jsp

Class CMSRequestContext

java.lang.Object

com.frameworkset.platform.cms.driver.jsp.CMSRequestContext

All Implemented Interfaces:

java.io.Serializable

public class CMSRequestContext
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQUEST_KEY The attribute key to bind the portal environment instance to servlet request.

Constructor Summary

Constructors

Constructor and Description
CMSRequestContext(javax.servlet.jsp.PageContext pageContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates a PortalRequestContext instance.

Method Summary

Modifier and Type	Method and Description
CMSURL	createCMSURL()
static CMSRequestContext	getContext(javax.servlet.http.HttpServletRequest request) Returns the portal environment from the servlet request.
DriverConfiguration	getDriverConfiguration()
javax.servlet.jsp.PageContext	getPageContext()
javax.servlet.http.HttpServletRequest	getRequest() Returns the servlet request.
CMSURL	getRequestedCmsURL() Returns the requested portal URL.
javax.servlet.http.HttpServletResponse	getResponse() Returns the servlet response.

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 java.lang.String REQUEST_KEY

The attribute key to bind the portal environment instance to servlet request.

Constructor Detail

CMSRequestContext

public CMSRequestContext(javax.servlet.jsp.PageContext pageContext,
                         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 CMSRequestContext 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.

getRequestedCmsURL

public CMSURL getRequestedCmsURL()

Returns the requested portal URL.

Returns:

the requested portal URL.

createCMSURL

public CMSURL createCMSURL()

getDriverConfiguration

public DriverConfiguration getDriverConfiguration()

getPageContext

public javax.servlet.jsp.PageContext getPageContext()