Spring Framework 6.1.4 · org.springframework.messaging.simp.SimpAttributesContextHolder

Modifier and Type	Field and Description
private static final ThreadLocal<SimpAttributes>	attributesHolder

Access	Constructor and Description
public	SimpAttributesContextHolder()

Method Summary

Modifier and Type	Method and Description
public static SimpAttributes	Returns: the attributes, never `null` currentAttributes() Return the SimpAttributes currently bound to the thread or raise an `java.lang.IllegalStateException` if none are bound.
public static SimpAttributes	Returns: the attributes or `null` if not bound getAttributes() Return the SimpAttributes currently bound to the thread.
public static void	resetAttributes() Reset the SimpAttributes for the current thread.
public static void	setAttributes(SimpAttributes the RequestAttributes to expose attributes) Bind the given SimpAttributes to the current thread.
public static void	setAttributesFromMessage(Message<?> the message to extract session attributes from message) Extract the SiMP session attributes from the given message, wrap them in a `SimpAttributes` instance and bind it to the current thread.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

attributesHolder	back to summary
private static final ThreadLocal<SimpAttributes> attributesHolder

SimpAttributesContextHolder	back to summary
public SimpAttributesContextHolder()

currentAttributes back to summary

currentAttributes	back to summary
public static SimpAttributes currentAttributes() throws IllegalStateException Return the SimpAttributes currently bound to the thread or raise an `java.lang.IllegalStateException` if none are bound. Returns:SimpAttributes the attributes, never `null` Exceptions IllegalStateException: if attributes are not bound

public static SimpAttributes currentAttributes() throws IllegalStateException

Return the SimpAttributes currently bound to the thread or raise an java.lang.IllegalStateException if none are bound.

the attributes, never null

Exceptions

getAttributes back to summary

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

public static SimpAttributes getAttributes()

Return the SimpAttributes currently bound to the thread.

the attributes or null if not bound

Annotations

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

setAttributes	back to summary
public static void setAttributes(SimpAttributes attributes) Bind the given SimpAttributes to the current thread. Parameters attributes:SimpAttributes the RequestAttributes to expose

setAttributes

public static void setAttributes(SimpAttributes attributes)

Bind the given SimpAttributes to the current thread.

Parameters

setAttributesFromMessage back to summary

setAttributesFromMessage	back to summary
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:Message<?> the message to extract session attributes from

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