ServletRequestAttributes (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.context.request
Class ServletRequestAttributes

java.lang.Object
  org.springframework.web.context.request.AbstractRequestAttributes
      org.springframework.web.context.request.ServletRequestAttributes

All Implemented Interfaces:: RequestAttributes

Direct Known Subclasses:: ServletWebRequest

public class ServletRequestAttributes
extends AbstractRequestAttributes
extends AbstractRequestAttributes

Servlet-based implementation of the RequestAttributes interface.

Accesses objects from servlet request and HTTP session scope, with no distinction between "session" and "global session".

Since:: 2.0
Author:: Juergen Hoeller
See Also:: ServletRequest.getAttribute(java.lang.String), HttpSession.getAttribute(java.lang.String)

Field Summary

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

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

ServletRequestAttributes(HttpServletRequest request)
          Create a new ServletRequestAttributes 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.

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

protected HttpSession getSession(boolean allowCreate)
          Exposes the HttpSession 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

Field Summary
`static String`	`DESTRUCTION_CALLBACK_NAME_PREFIX` Constant identifying the `String` prefixed to the name of a destruction callback when it is stored in a `HttpSession`.

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
`ServletRequestAttributes(HttpServletRequest request)` Create a new ServletRequestAttributes 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.
`HttpServletRequest`	`getRequest()` Exposes the native `HttpServletRequest` that we're wrapping.
`protected HttpSession`	`getSession(boolean allowCreate)` Exposes the `HttpSession` 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`

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

Constructor Detail

ServletRequestAttributes

public ServletRequestAttributes(HttpServletRequest request)

Create a new ServletRequestAttributes instance for the given request.

Parameters:: request - current HTTP request

Method Detail

getRequest

public final HttpServletRequest getRequest()

Exposes the native HttpServletRequest that we're wrapping.

getSession

protected final HttpSession getSession(boolean allowCreate)

Exposes the HttpSession that we're wrapping.

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