类 PortletContextScope
- java.lang.Object
- org.springframework.web.portlet.context.PortletContextScope
- 所有已实现的接口:
Scope
,DisposableBean
public class PortletContextScope extends Object implements Scope, DisposableBean
Scope
wrapper for a PortletContext, i.e. for global web application attributes.This differs from traditional Spring singletons in that it exposes attributes in the PortletContext. 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
ContextCleanupListener
being registered inweb.xml
. Note thatContextLoaderListener
includes ContextCleanupListener's functionality.This scope is registered as default scope with key
"application"
.- 从以下版本开始:
- 3.0
- 作者:
- Juergen Hoeller
- 另请参阅:
ContextCleanupListener
构造器概要
构造器 构造器 说明 PortletContextScope(PortletContext portletContext)
Create a new Scope wrapper for the given PortletContext.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 void
destroy()
Invoke all registered destruction callbacks.Object
get(String name, ObjectFactory<?> objectFactory)
Return the object with the given name from the underlying scope,creating it
if not found in the underlying storage mechanism.String
getConversationId()
Return the conversation ID for the current underlying scope, if any.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 givenname
from the underlying scope.Object
resolveContextualObject(String key)
Resolve the contextual object for the given key, if any.
构造器详细资料
PortletContextScope
public PortletContextScope(PortletContext portletContext)
Create a new Scope wrapper for the given PortletContext.- 参数:
portletContext
- the PortletContext to wrap
方法详细资料
get
public Object get(String name, ObjectFactory<?> objectFactory)
从接口复制的说明:Scope
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.
- 指定者:
get
在接口中Scope
- 参数:
name
- the name of the object to retrieveobjectFactory
- theObjectFactory
to use to create the scoped object if it is not present in the underlying storage mechanism- 返回:
- the desired object (never
null
)
remove
public Object remove(String name)
从接口复制的说明:Scope
Remove the object with the givenname
from the underlying scope.Returns
null
if no object was found; otherwise returns the removedObject
.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.- 指定者:
remove
在接口中Scope
- 参数:
name
- the name of the object to remove- 返回:
- the removed object, or
null
if no object was present - 另请参阅:
Scope.registerDestructionCallback(java.lang.String, java.lang.Runnable)
registerDestructionCallback
public void registerDestructionCallback(String name, Runnable callback)
从接口复制的说明:Scope
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
Scope.remove(String)
method, any registered destruction callback should be removed as well, assuming that the removed object will be reused or manually destroyed.- 指定者:
registerDestructionCallback
在接口中Scope
- 参数:
name
- the name of the object to execute the destruction callback forcallback
- 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.- 另请参阅:
DisposableBean
,AbstractBeanDefinition.getDestroyMethodName()
,DestructionAwareBeanPostProcessor
resolveContextualObject
public Object resolveContextualObject(String key)
从接口复制的说明:Scope
Resolve the contextual object for the given key, if any. E.g. the HttpServletRequest object for key "request".- 指定者:
resolveContextualObject
在接口中Scope
- 参数:
key
- the contextual key- 返回:
- the corresponding object, or
null
if none found
getConversationId
public String getConversationId()
从接口复制的说明:Scope
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.- 指定者:
getConversationId
在接口中Scope
- 返回:
- the conversation ID, or
null
if there is no conversation ID for the current scope
destroy
public void destroy()
Invoke all registered destruction callbacks. To be called on ServletContext shutdown.- 指定者:
destroy
在接口中DisposableBean
- 另请参阅:
ContextCleanupListener