Class SimpAttributesContextHolder

java.lang.Object
org.springframework.messaging.simp.SimpAttributesContextHolder
public abstract class SimpAttributesContextHolder extends Object
Holder class to expose SiMP attributes associated with a session (for example, WebSocket) in the form of a thread-bound SimpAttributes object.
Since:
4.1
Author:
Rossen Stoyanchev

  • Constructor Details

    • SimpAttributesContextHolder

      public SimpAttributesContextHolder()

  • Method Details

    • resetAttributes

      public static void resetAttributes()
      Reset the SimpAttributes for the current thread.

    • setAttributes

      public static void setAttributes(@Nullable SimpAttributes attributes)
      Bind the given SimpAttributes to the current thread.
      Parameters:
      attributes - the RequestAttributes to expose

    • setAttributesFromMessage

      public static void setAttributesFromMessage(Message<?> message)
      Extract the SiMP session attributes from the given message, wrap them in a SimpAttributes instance and bind it to the current thread.
      Parameters:
      message - the message to extract session attributes from

    • getAttributes

      public static @Nullable SimpAttributes getAttributes()
      Return the SimpAttributes currently bound to the thread.
      Returns:
      the attributes or null if not bound

    • currentAttributes

      public static SimpAttributes currentAttributes() throws IllegalStateException
      Return the SimpAttributes currently bound to the thread or raise an IllegalStateException if none are bound.
      Returns:
      the attributes, never null
      Throws:
      IllegalStateException - if attributes are not bound