org.springframework.web.portlet.context

Class PortletRequestAttributes

java.lang.Object

org.springframework.web.context.request.AbstractRequestAttributes

org.springframework.web.portlet.context.PortletRequestAttributes

All Implemented Interfaces:

org.springframework.web.context.request.RequestAttributes

Direct Known Subclasses:

PortletWebRequest

public class PortletRequestAttributes
extends org.springframework.web.context.request.AbstractRequestAttributes

Portlet-based implementation of the RequestAttributes interface.

Accesses objects from portlet request and portlet session scope, with a distinction between "session" (the PortletSession's "portlet scope") and "global session" (the PortletSession's "application scope").

Since:

2.0

Author:

Juergen Hoeller

See Also:

PortletRequest.getAttribute(java.lang.String), PortletSession.getAttribute(java.lang.String), PortletSession.PORTLET_SCOPE, PortletSession.APPLICATION_SCOPE, RequestAttributes.SCOPE_SESSION, RequestAttributes.SCOPE_GLOBAL_SESSION

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESTRUCTION_CALLBACK_NAME_PREFIX Constant identifying the String prefixed to the name of a destruction callback when it is stored in a PortletSession.

Fields inherited from class org.springframework.web.context.request.AbstractRequestAttributes

requestDestructionCallbacks

Fields inherited from interface org.springframework.web.context.request.RequestAttributes

REFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION

Constructor Summary

Constructors

Constructor and Description
PortletRequestAttributes(PortletRequest request) Create a new PortletRequestAttributes instance for the given request.
PortletRequestAttributes(PortletRequest request, PortletResponse response) Create a new PortletRequestAttributes instance for the given request.

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name, int scope)
String[]	getAttributeNames(int scope)
PortletRequest	getRequest() Exposes the native PortletRequest that we're wrapping.
PortletResponse	getResponse() Exposes the native PortletResponse that we're wrapping (if any).
protected PortletSession	getSession(boolean allowCreate) Exposes the PortletSession that we're wrapping.
String	getSessionId()
Object	getSessionMutex()
void	registerDestructionCallback(String name, Runnable callback, int scope)
protected void	registerSessionDestructionCallback(String name, Runnable callback) Register the given callback as to be executed after session termination.
void	removeAttribute(String name, int scope)
Object	resolveReference(String key)
void	setAttribute(String name, Object value, int scope)
String	toString()
protected void	updateAccessedSessionAttributes() Update all accessed session attributes through session.setAttribute calls, explicitly indicating to the container that they might have been modified.

Methods inherited from class org.springframework.web.context.request.AbstractRequestAttributes

isRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted

Methods inherited from class java.lang.Object

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

Field Detail

DESTRUCTION_CALLBACK_NAME_PREFIX

public static final String DESTRUCTION_CALLBACK_NAME_PREFIX

Constant identifying the String prefixed to the name of a destruction callback when it is stored in a PortletSession.

Constructor Detail

PortletRequestAttributes

public PortletRequestAttributes(PortletRequest request)

Create a new PortletRequestAttributes instance for the given request.

Parameters:

request - current portlet request

PortletRequestAttributes

public PortletRequestAttributes(PortletRequest request,
                                PortletResponse response)

Create a new PortletRequestAttributes instance for the given request.

Parameters:

request - current portlet request

response - current portlet response (for optional exposure)

Method Detail

getRequest

public final PortletRequest getRequest()

Exposes the native PortletRequest that we're wrapping.

getResponse

public final PortletResponse getResponse()

Exposes the native PortletResponse that we're wrapping (if any).

getSession

protected final PortletSession getSession(boolean allowCreate)

Exposes the PortletSession that we're wrapping.

Parameters:

allowCreate - whether to allow creation of a new session if none exists yet

getAttribute

public Object getAttribute(String name,
                           int scope)

setAttribute

public void setAttribute(String name,
                         Object value,
                         int scope)

removeAttribute

public void removeAttribute(String name,
                            int scope)

getAttributeNames

public String[] getAttributeNames(int scope)

registerDestructionCallback

public void registerDestructionCallback(String name,
                                        Runnable callback,
                                        int scope)

resolveReference

public Object resolveReference(String key)

getSessionId

public String getSessionId()

getSessionMutex

public Object getSessionMutex()

updateAccessedSessionAttributes

protected void updateAccessedSessionAttributes()

Update all accessed session attributes through session.setAttribute calls, explicitly indicating to the container that they might have been modified.

Specified by:

updateAccessedSessionAttributes in class org.springframework.web.context.request.AbstractRequestAttributes

registerSessionDestructionCallback

protected void registerSessionDestructionCallback(String name,
                                                  Runnable callback)

Register the given callback as to be executed after session termination.

Note: The callback object should be serializable in order to survive web app restarts.

Parameters:

name - the name of the attribute to register the callback for

callback - the callback to be executed for destruction

toString

public String toString()

Overrides:

toString in class Object