类 PortletRequestAttributes

字段详细资料

• 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.

构造器详细资料

• PortletRequestAttributes

  public PortletRequestAttributes​(PortletRequest request)

  Create a new PortletRequestAttributes instance for the given request.

  参数:

  request - current portlet request

• PortletRequestAttributes

  public PortletRequestAttributes​(PortletRequest request,
                                  PortletResponse response)

  Create a new PortletRequestAttributes instance for the given request.

  参数:

  request - current portlet request

  response - current portlet response (for optional exposure)

方法详细资料

• 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.

  参数:

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

• getAttribute

  public Object getAttribute​(String name,
                             int scope)

  从接口复制的说明: RequestAttributes
  Return the value for the scoped attribute of the given name, if any.

  参数:

  name - the name of the attribute

  scope - the scope identifier

  返回:

  the current attribute value, or null if not found

• setAttribute

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

  从接口复制的说明: RequestAttributes
  Set the value for the scoped attribute of the given name, replacing an existing value (if any).

  参数:

  name - the name of the attribute

  value - the value for the attribute

  scope - the scope identifier

• removeAttribute

  public void removeAttribute​(String name,
                              int scope)

  从接口复制的说明: RequestAttributes
  Remove the scoped attribute of the given name, if it exists.

  Note that an implementation should also remove a registered destruction callback for the specified attribute, if any. It does, however, not need to execute a registered destruction callback in this case, since the object will be destroyed by the caller (if appropriate).

  参数:

  name - the name of the attribute

  scope - the scope identifier

• getAttributeNames

  public String[] getAttributeNames​(int scope)

  从接口复制的说明: RequestAttributes
  Retrieve the names of all attributes in the scope.

  参数:

  scope - the scope identifier

  返回:

  the attribute names as String array

• registerDestructionCallback

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

  从接口复制的说明: RequestAttributes
  Register a callback to be executed on destruction of the specified attribute in the given scope.

  Implementations should do their best to execute the callback at the appropriate time: that is, at request completion or session termination, respectively. If such a callback is not supported by the underlying runtime environment, the callback must be ignored and a corresponding warning should be logged.

  Note that 'destruction' usually corresponds to destruction of the entire scope, not to the individual attribute having been explicitly removed by the application. If an attribute gets removed via this facade's RequestAttributes.removeAttribute(String, int) method, any registered destruction callback should be disabled as well, assuming that the removed object will be reused or manually destroyed.

  NOTE: Callback objects should generally be serializable if they are being registered for a session scope. Otherwise the callback (or even the entire session) might not survive web app restarts.

  参数:

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

  callback - the destruction callback to be executed

  scope - the scope identifier

• resolveReference

  public Object resolveReference​(String key)

  从接口复制的说明: RequestAttributes
  Resolve the contextual reference for the given key, if any.

  At a minimum: the HttpServletRequest/PortletRequest reference for key "request", and the HttpSession/PortletSession reference for key "session".

  参数:

  key - the contextual key

  返回:

  the corresponding object, or null if none found

• getSessionId

  public String getSessionId()

  从接口复制的说明: RequestAttributes
  Return an id for the current underlying session.

  返回:

  the session id as String (never null)

• getSessionMutex

  public Object getSessionMutex()

  从接口复制的说明: RequestAttributes
  Expose the best available mutex for the underlying session: that is, an object to synchronize on for the underlying session.

  返回:

  the session mutex to use (never null)

• updateAccessedSessionAttributes

  protected void updateAccessedSessionAttributes()

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

  指定者:

  updateAccessedSessionAttributes 在类中 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.

  参数:

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

  callback - the callback to be executed for destruction

• toString

  public String toString()

  覆盖:

  toString 在类中 Object