public abstract class

AbstractRequestAttributesScope

extends Object
implements Scope
java.lang.Object
   ↳ org.springframework.web.context.request.AbstractRequestAttributesScope
Known Direct Subclasses

Class Overview

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(String, ObjectFactory) and remove(String) methods to add synchronization around the call back into this super class.

Summary

Public Constructors
AbstractRequestAttributesScope()
Public Methods
Object get(String name, ObjectFactory objectFactory)
void registerDestructionCallback(String name, Runnable callback)
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).
Object remove(String name)
Remove the object with the given name from the underlying scope.
Object resolveContextualObject(String key)
Resolve the contextual object for the given key, if any.
Protected Methods
abstract int getScope()
Template method that determines the actual target scope.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.config.Scope

Public Constructors

public AbstractRequestAttributesScope ()

Public Methods

public Object get (String name, ObjectFactory objectFactory)

public void registerDestructionCallback (String name, Runnable callback)

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 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 the name of the object to execute the destruction callback for
callback 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.

public Object remove (String name)

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 the name of the object to remove
Returns
  • the removed object, or null if no object was present

public Object resolveContextualObject (String key)

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

Parameters
key the contextual key
Returns
  • the corresponding object, or null if none found

Protected Methods

protected abstract int getScope ()

Template method that determines the actual target scope.

Returns
See Also