PortletRequestAttributes (Spring Framework API 2.0) - Spring Framework 2.0.5 API 文档英文版

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

The Spring Framework

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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:: RequestAttributes

Direct Known Subclasses:: PortletWebRequest

public class PortletRequestAttributes
extends AbstractRequestAttributes
extends 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 inherited from class org.springframework.web.context.request.AbstractRequestAttributes

requestDestructionCallbacks

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

SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION

Constructor Summary

PortletRequestAttributes(PortletRequest request)
          Create a new PortletRequestAttributes instance for the given request.

Method Summary

Object getAttribute(String name, int scope)
          Return the value for the scoped attribute of the given name, if any.

PortletRequest getRequest()
          Exposes the native PortletRequest that we're wrapping.

protected PortletSession getSession(boolean allowCreate)
          Exposes the PortletSession that we're wrapping.

String getSessionId()
          Return an id for the current underlying session.

Object getSessionMutex()
          Expose the best available mutex for the underlying session: that is, an object to synchronize on for the underlying session.

void registerDestructionCallback(String name, Runnable callback, int scope)
          Register a callback to be executed on destruction of the specified attribute in the given scope.

void removeAttribute(String name, int scope)
          Remove the scoped attribute of the given name, if it exists.

void setAttribute(String name, Object value, int scope)
          Set the value for the scoped attribute of the given name, replacing an existing value (if any).

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

registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted

Methods inherited from class java.lang.Object

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

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

Fields inherited from interface org.springframework.web.context.request.RequestAttributes
`SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION`

Constructor Summary
`PortletRequestAttributes(PortletRequest request)` Create a new PortletRequestAttributes instance for the given request.

Method Summary
`Object`	`getAttribute(String name, int scope)` Return the value for the scoped attribute of the given name, if any.
`PortletRequest`	`getRequest()` Exposes the native `PortletRequest` that we're wrapping.
`protected PortletSession`	`getSession(boolean allowCreate)` Exposes the `PortletSession` that we're wrapping.
`String`	`getSessionId()` Return an id for the current underlying session.
`Object`	`getSessionMutex()` Expose the best available mutex for the underlying session: that is, an object to synchronize on for the underlying session.
`void`	`registerDestructionCallback(String name, Runnable callback, int scope)` Register a callback to be executed on destruction of the specified attribute in the given scope.
`void`	`removeAttribute(String name, int scope)` Remove the scoped attribute of the given name, if it exists.
`void`	`setAttribute(String name, Object value, int scope)` Set the value for the scoped attribute of the given name, replacing an existing value (if any).
`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
`registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

PortletRequestAttributes

public PortletRequestAttributes(PortletRequest request)

Create a new PortletRequestAttributes instance for the given request.

Parameters:: request - current portlet request

Method Detail

getRequest

public final PortletRequest getRequest()

Exposes the native PortletRequest that we're wrapping.

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