Top Description Constructors Methods
org.springframework.web.context.request

public abstract Class AbstractRequestAttributesScope

extends Object
implements Scope
Class Inheritance
All Implemented Interfaces
org.springframework.beans.factory.config.Scope
Known Direct Subclasses
org.springframework.web.context.request.RequestScope, org.springframework.web.context.request.SessionScope
Imports
org.springframework.beans.factory.ObjectFactory, org.springframework.beans.factory.config.Scope, org.springframework.lang.Nullable
Abstract Scope implementation that reads from a particular scope in the current thread-bound RequestAttributes object.

Subclasses simply need to implement getScope() to instruct this class which RequestAttributes scope to read attributes from.

Subclasses may wish to override the get and remove methods to add synchronization around the call back into this superclass.

Authors
Rod Johnson, Juergen Hoeller, Rob Harrop
Since
2.0

Constructor Summary

AccessConstructor and Description
public
AbstractRequestAttributesScope()

Method Summary

Modifier and TypeMethod and Description
public Object
get(String
the name of the object to retrieve
name, ObjectFactory<?>
the ObjectFactory to use to create the scoped object if it is not present in the underlying storage mechanism
objectFactory)

Implements org.springframework.beans.factory.config.Scope.get.

Return the object with the given name from the underlying scope, creating it if not found in the underlying storage mechanism.
protected abstract int

Returns:

the target scope, in the form of an appropriate RequestAttributes constant
getScope()

Template method that determines the actual target scope.

public void
registerDestructionCallback(String
the name of the object to execute the destruction callback for
name, Runnable
the destruction callback to be executed. Note that the passed-in Runnable will never throw an exception, so it can safely be executed without an enclosing try-catch block. Furthermore, the Runnable will usually be serializable, provided that its target object is serializable as well.
callback)

Implements org.springframework.beans.factory.config.Scope.registerDestructionCallback.

Register a callback to be executed on destruction of the specified object in the scope (or at destruction of the entire scope, if the scope does not destroy individual objects but rather only terminates in its entirety).
public Object
remove(String
the name of the object to remove
name)

Implements org.springframework.beans.factory.config.Scope.remove.

Remove the object with the given name from the underlying scope.
public Object
resolveContextualObject(String
the contextual key
key)

Implements org.springframework.beans.factory.config.Scope.resolveContextualObject.

Resolve the contextual object for the given key, if any.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AbstractRequestAttributesScopeback to summary
public AbstractRequestAttributesScope()

Method Detail

getback to summary
public Object get(String name, ObjectFactory<?> objectFactory)

Implements org.springframework.beans.factory.config.Scope.get.

Doc from org.springframework.beans.factory.config.Scope.get.

Return the object with the given name from the underlying scope, creating it if not found in the underlying storage mechanism.

This is the central operation of a Scope, and the only operation that is absolutely required.

Parameters
name:String

the name of the object to retrieve

objectFactory:ObjectFactory<?>

the ObjectFactory to use to create the scoped object if it is not present in the underlying storage mechanism

Returns:Object

the desired object (never null)

Annotations
@Override
getScopeback to summary
protected abstract int getScope()

Template method that determines the actual target scope.

Returns:int

the target scope, in the form of an appropriate RequestAttributes constant

See Also
RequestAttributes#SCOPE_REQUEST, RequestAttributes#SCOPE_SESSION
registerDestructionCallbackback to summary
public void registerDestructionCallback(String name, Runnable callback)

Implements org.springframework.beans.factory.config.Scope.registerDestructionCallback.

Doc from org.springframework.beans.factory.config.Scope.registerDestructionCallback.

Register a callback to be executed on destruction of the specified object in the scope (or at destruction of the entire scope, if the scope does not destroy individual objects but rather only terminates in its entirety).

Note: This is an optional operation. This method will only be called for scoped beans with actual destruction configuration (DisposableBean, destroy-method, DestructionAwareBeanPostProcessor). Implementations should do their best to execute a given callback at the appropriate time. If such a callback is not supported by the underlying runtime environment at all, the callback must be ignored and a corresponding warning should be logged.

Note that 'destruction' refers to automatic destruction of the object as part of the scope's own lifecycle, not to the individual scoped object having been explicitly removed by the application. If a scoped object gets removed via this facade's remove(String) method, any registered destruction callback should be removed as well, assuming that the removed object will be reused or manually destroyed.

Parameters
name:String

the name of the object to execute the destruction callback for

callback:Runnable

the destruction callback to be executed. Note that the passed-in Runnable will never throw an exception, so it can safely be executed without an enclosing try-catch block. Furthermore, the Runnable will usually be serializable, provided that its target object is serializable as well.

Annotations
@Override
removeback to summary
public Object remove(String name)

Implements org.springframework.beans.factory.config.Scope.remove.

Doc from org.springframework.beans.factory.config.Scope.remove.

Remove the object with the given name from the underlying scope.

Returns null if no object was found; otherwise returns the removed Object.

Note that an implementation should also remove a registered destruction callback for the specified object, 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).

Note: This is an optional operation. Implementations may throw UnsupportedOperationException if they do not support explicitly removing an object.

Parameters
name:String

the name of the object to remove

Returns:Object

the removed object, or null if no object was present

Annotations
@Override
@Nullable
resolveContextualObjectback to summary
public Object resolveContextualObject(String key)

Implements org.springframework.beans.factory.config.Scope.resolveContextualObject.

Doc from org.springframework.beans.factory.config.Scope.resolveContextualObject.

Resolve the contextual object for the given key, if any. E.g. the HttpServletRequest object for key "request".

Parameters
key:String

the contextual key

Returns:Object

the corresponding object, or null if none found

Annotations
@Override
@Nullable