Top Description Fields Constructors Methods
org.springframework.web.context.support

public Class ServletContextScope

extends Object
implements Scope, DisposableBean
Class Inheritance
All Implemented Interfaces
org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.config.Scope
Imports
java.util.LinkedHashMap, .Map, jakarta.servlet.ServletContext, org.springframework.beans.factory.DisposableBean, .ObjectFactory, org.springframework.beans.factory.config.Scope, org.springframework.lang.Nullable, org.springframework.util.Assert
Scope wrapper for a ServletContext, i.e. for global web application attributes.

This differs from traditional Spring singletons in that it exposes attributes in the ServletContext. Those attributes will get destroyed whenever the entire application shuts down, which might be earlier or later than the shutdown of the containing Spring ApplicationContext.

The associated destruction mechanism relies on a org.springframework.web.context.ContextCleanupListener being registered in web.xml. Note that org.springframework.web.context.ContextLoaderListener includes ContextCleanupListener's functionality.

This scope is registered as default scope with key "application".

Author
Juergen Hoeller
Since
3.0
See Also
org.springframework.web.context.ContextCleanupListener

Field Summary

Modifier and TypeField and Description
private final Map<String, Runnable>
destructionCallbacks

private final ServletContext
servletContext

Constructor Summary

AccessConstructor and Description
public
ServletContextScope(ServletContext
the ServletContext to wrap
servletContext)

Create a new Scope wrapper for the given ServletContext.

Method Summary

Modifier and TypeMethod and Description
public void
destroy()

Implements org.springframework.beans.factory.DisposableBean.destroy.

Invoke all registered destruction callbacks.
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.
public String
getConversationId()

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

Return the conversation ID for the current underlying scope, if any.
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

Field Detail

destructionCallbacksback to summary
private final Map<String, Runnable> destructionCallbacks
servletContextback to summary
private final ServletContext servletContext

Constructor Detail

ServletContextScopeback to summary
public ServletContextScope(ServletContext servletContext)

Create a new Scope wrapper for the given ServletContext.

Parameters
servletContext:ServletContext

the ServletContext to wrap

Method Detail

destroyback to summary
public void destroy()

Implements org.springframework.beans.factory.DisposableBean.destroy.

Invoke all registered destruction callbacks. To be called on ServletContext shutdown.

Annotations
@Override
See Also
org.springframework.web.context.ContextCleanupListener
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
getConversationIdback to summary
public String getConversationId()

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

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

Return the conversation ID for the current underlying scope, if any.

The exact meaning of the conversation ID depends on the underlying storage mechanism. In the case of session-scoped objects, the conversation ID would typically be equal to (or derived from) the session ID; in the case of a custom conversation that sits within the overall session, the specific ID for the current conversation would be appropriate.

Note: This is an optional operation. It is perfectly valid to return null in an implementation of this method if the underlying storage mechanism has no obvious candidate for such an ID.

Returns:String

the conversation ID, or null if there is no conversation ID for the current scope

Annotations
@Override
@Nullable
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