org.exoplatform.web.application

Class RequestContext

java.lang.Object

org.exoplatform.web.application.RequestContext

public abstract class RequestContext
extends Object

Created by The eXo Platform SAS May 7, 2006 This abstract class is a wrapper on top of the request information such as the Locale in use, the application (for instance PortalApplication, PortletApplication...), an access to the JavascriptManager as well as a reference to the URLBuilder in use. It also contains a ThreadLocal object for an easy access. Context can be nested and hence a getParentAppRequestContext() is also available

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION
protected RequestContext	parentAppRequestContext_

Constructor Summary

Constructors

Modifier	Constructor and Description
	RequestContext(Application app)
protected	RequestContext(RequestContext parentAppRequestContext, Application app_)

Method Summary

Modifier and Type	Method and Description
<R,L extends PortalURL<R,L>> L	createURL(ResourceType<R,L> resourceType)
<R,U extends PortalURL<R,U>> U	createURL(ResourceType<R,U> resourceType, R resource)
Application	getApplication()
ResourceBundle	getApplicationResourceBundle()
ApplicationSession	getApplicationSession()
Object	getAttribute(Class type)
Object	getAttribute(String name)
static <T extends RequestContext> T	getCurrentInstance()
boolean	getFullRender()
Locale	getLocale()
abstract org.exoplatform.services.resources.Orientation	getOrientation() Returns the orientation for the current request.
RequestContext	getParentAppRequestContext()
String	getRemoteUser()
abstract String	getRequestParameter(String name)
abstract String[]	getRequestParameterValues(String name)
abstract URLBuilder<?>	getURLBuilder()
abstract URLFactory	getURLFactory() Returns the url factory associated with this context.
abstract UserPortal	getUserPortal()
Writer	getWriter()
boolean	isUserInRole(String roleUser)
abstract <R,U extends PortalURL<R,U>> U	newURL(ResourceType<R,U> resourceType, URLFactory urlFactory)
void	setAttribute(Class type, Object value)
void	setAttribute(String name, Object value)
static void	setCurrentInstance(RequestContext ctx)
void	setWriter(Writer writer)
abstract boolean	useAjax()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACTION

public static final String ACTION

See Also:

Constant Field Values

parentAppRequestContext_

protected final RequestContext parentAppRequestContext_

Constructor Detail

RequestContext

public RequestContext(Application app)

RequestContext

protected RequestContext(RequestContext parentAppRequestContext,
                         Application app_)

Method Detail

getApplication

public Application getApplication()

getLocale

public Locale getLocale()

getURLFactory

public abstract URLFactory getURLFactory()

Returns the url factory associated with this context.

Returns:

the url factory

newURL

public abstract <R,U extends PortalURL<R,U>> U newURL(ResourceType<R,U> resourceType,
                                                      URLFactory urlFactory)

createURL

public final <R,U extends PortalURL<R,U>> U createURL(ResourceType<R,U> resourceType,
                                                      R resource)

createURL

public final <R,L extends PortalURL<R,L>> L createURL(ResourceType<R,L> resourceType)

getOrientation

public abstract org.exoplatform.services.resources.Orientation getOrientation()

Returns the orientation for the current request.

Returns:

the orientation

getApplicationResourceBundle

public ResourceBundle getApplicationResourceBundle()

getRequestParameter

public abstract String getRequestParameter(String name)

getRequestParameterValues

public abstract String[] getRequestParameterValues(String name)

getURLBuilder

public abstract URLBuilder<?> getURLBuilder()

getRemoteUser

public String getRemoteUser()

isUserInRole

public boolean isUserInRole(String roleUser)

useAjax

public abstract boolean useAjax()

getFullRender

public boolean getFullRender()

getApplicationSession

public ApplicationSession getApplicationSession()

getWriter

public Writer getWriter()
                 throws Exception

Throws:

Exception

setWriter

public void setWriter(Writer writer)

getAttribute

public final Object getAttribute(String name)

setAttribute

public final void setAttribute(String name,
                               Object value)

getAttribute

public final Object getAttribute(Class type)

setAttribute

public final void setAttribute(Class type,
                               Object value)

getParentAppRequestContext

public RequestContext getParentAppRequestContext()

getUserPortal

public abstract UserPortal getUserPortal()

getCurrentInstance

public static <T extends RequestContext> T getCurrentInstance()

setCurrentInstance

public static void setCurrentInstance(RequestContext ctx)