Package org.springframework.messaging.simp

Class SimpSessionScope

java.lang.Object
org.springframework.messaging.simp.SimpSessionScope
All Implemented Interfaces:
Scope
public class SimpSessionScope extends Object implements Scope
A Scope implementation exposing the attributes of a SiMP session (e.g. WebSocket session).

Relies on a thread-bound SimpAttributes instance exported by SimpAnnotationMethodMessageHandler.

Since:
4.1
Author:
Rossen Stoyanchev

  • Constructor Details

    • SimpSessionScope

      public SimpSessionScope()

  • Method Details

    • get

      public Object get(String name, ObjectFactory<?> objectFactory)
      Description copied from interface: 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.

      Specified by:
      get in interface Scope
      Parameters:
      name - the name of the object to retrieve
      objectFactory - the ObjectFactory to use to create the scoped object if it is not present in the underlying storage mechanism
      Returns:
      the desired object (never null)

    • remove

      @Nullable public Object remove(String name)
      Description copied from interface: Scope
      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.

      Specified by:
      remove in interface Scope
      Parameters:
      name - the name of the object to remove
      Returns:
      the removed object, or null if no object was present
      See Also:

    • registerDestructionCallback

      public void registerDestructionCallback(String name, Runnable callback)
      Description copied from interface: 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.

      Specified by:
      registerDestructionCallback in interface Scope
      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.
      See Also:

    • resolveContextualObject

      @Nullable public Object resolveContextualObject(String key)
      Description copied from interface: Scope
      Resolve the contextual object for the given key, if any. E.g. the HttpServletRequest object for key "request".
      Specified by:
      resolveContextualObject in interface Scope
      Parameters:
      key - the contextual key
      Returns:
      the corresponding object, or null if none found

    • getConversationId

      public String getConversationId()
      Description copied from interface: 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.

      Specified by:
      getConversationId in interface Scope
      Returns:
      the conversation ID, or null if there is no conversation ID for the current scope