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

Field Summary

Modifier and Type	Field and Description
public static final String	CONNECT_MESSAGE_HEADER
public static final String	DESTINATION_HEADER
public static final String	DISCONNECT_MESSAGE_HEADER
private static final IdTimestampMessageHeaderInitializer	headerInitializer
public static final String	HEART_BEAT_HEADER
public static final String	IGNORE_ERROR A header that indicates to the broker that the sender will ignore errors.
public static final String	MESSAGE_TYPE_HEADER
public static final String	ORIGINAL_DESTINATION A header for internal use with "user" destinations where we need to restore the destination prior to sending messages to clients.
public static final String	SESSION_ATTRIBUTES
public static final String	SESSION_ID_HEADER
public static final String	SUBSCRIPTION_ID_HEADER
public static final String	USER_HEADER
private Consumer<Principal>	userCallback

Inherited from org.springframework.messaging.support.NativeMessageHeaderAccessor:: NATIVE_HEADERS

Constructor Summary

Access	Constructor and Description
protected	SimpMessageHeaderAccessor(SimpMessageType messageType, Map<String, List<String>> externalSourceHeaders) A constructor for creating new message headers.
protected	SimpMessageHeaderAccessor(Message<?> message) A constructor for accessing and modifying existing message headers.

Method Summary

Modifier and Type	Method and Description
public static SimpMessageHeaderAccessor	create() Create an instance with `org.springframework.messaging.simp.SimpMessageType` `MESSAGE`.
public static SimpMessageHeaderAccessor	create(SimpMessageType messageType) Create an instance with the given `org.springframework.messaging.simp.SimpMessageType`.
protected MessageHeaderAccessor	createAccessor(Message<?> the message to build a new accessor for message) Overrides org.springframework.messaging.support.MessageHeaderAccessor.createAccessor. Build a 'nested' accessor for the given message.
private StringBuilder	getBaseLogMessage()
public String	getDestination()
public static String	getDestination(Map<String, Object> headers)
public String	getDetailedLogMessage(Object the payload that corresponds to the headers. payload) Overrides org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage. Return a more detailed message for logging purposes.
public static long[]	getHeartbeat(Map<String, Object> headers)
public SimpMessageType	getMessageType()
public static SimpMessageType	getMessageType(Map<String, Object> headers)
public Map<String, Object>	getSessionAttributes() Return the attributes associated with the current session.
public static Map<String, Object>	getSessionAttributes(Map<String, Object> headers)
public String	getSessionId() Return the id of the current session.
public static String	getSessionId(Map<String, Object> headers)
public String	getShortLogMessage(Object the payload that corresponds to the headers. payload) Overrides org.springframework.messaging.support.MessageHeaderAccessor.getShortLogMessage. Return a concise message for logging purposes.
public String	getSubscriptionId()
public static String	getSubscriptionId(Map<String, Object> headers)
public Principal	getUser() Return the user associated with the current session.
public static Principal	getUser(Map<String, Object> headers)
public void	setDestination(String destination)
public void	setMessageTypeIfNotSet(SimpMessageType messageType)
public void	setSessionAttributes(Map<String, Object> attributes) A static alternative for access to the session attributes header.
public void	setSessionId(String sessionId)
public void	setSubscriptionId(String subscriptionId)
public void	setUser(Principal principal)
public void	setUserChangeCallback(Consumer<Principal> the callback to invoke callback) Provide a callback to be invoked if and when `setUser(Principal)` is called.
public static SimpMessageHeaderAccessor	wrap(Message<?> message) Create an instance by copying the headers of a Message.

Inherited from org.springframework.messaging.support.NativeMessageHeaderAccessor:: addNativeHeader addNativeHeaders containsNativeHeader copyHeaders copyHeadersIfAbsent getFirstNativeHeader getFirstNativeHeader getNativeHeader getNativeHeaders removeNativeHeader setImmutable setNativeHeader setNativeHeaderValues toNativeHeaderMap

Field Detail

CONNECT_MESSAGE_HEADER	back to summary
public static final String CONNECT_MESSAGE_HEADER

DESTINATION_HEADER	back to summary
public static final String DESTINATION_HEADER

DISCONNECT_MESSAGE_HEADER	back to summary
public static final String DISCONNECT_MESSAGE_HEADER

headerInitializer	back to summary
private static final IdTimestampMessageHeaderInitializer headerInitializer

HEART_BEAT_HEADER	back to summary
public static final String HEART_BEAT_HEADER

IGNORE_ERROR	back to summary
public static final String IGNORE_ERROR A header that indicates to the broker that the sender will ignore errors. The header is simply checked for presence or absence.

MESSAGE_TYPE_HEADER	back to summary
public static final String MESSAGE_TYPE_HEADER

ORIGINAL_DESTINATION	back to summary
public static final String ORIGINAL_DESTINATION A header for internal use with "user" destinations where we need to restore the destination prior to sending messages to clients.

SESSION_ATTRIBUTES	back to summary
public static final String SESSION_ATTRIBUTES

SESSION_ID_HEADER	back to summary
public static final String SESSION_ID_HEADER

SUBSCRIPTION_ID_HEADER	back to summary
public static final String SUBSCRIPTION_ID_HEADER

USER_HEADER	back to summary
public static final String USER_HEADER

userCallback	back to summary
private Consumer<Principal> userCallback Annotations @Nullable

Constructor Detail

SimpMessageHeaderAccessor	back to summary
protected SimpMessageHeaderAccessor(SimpMessageType messageType, Map<String, List<String>> externalSourceHeaders) A constructor for creating new message headers. This constructor is protected. See factory methods in this class and subclasses.

SimpMessageHeaderAccessor

back to summary

protected SimpMessageHeaderAccessor(SimpMessageType messageType, Map<String, List<String>> externalSourceHeaders)

A constructor for creating new message headers.

This constructor is protected. See factory methods in this class and subclasses.

SimpMessageHeaderAccessor	back to summary
protected SimpMessageHeaderAccessor(Message<?> message) A constructor for accessing and modifying existing message headers. This constructor is protected. See factory methods in this class and subclasses.

SimpMessageHeaderAccessor

back to summary

protected SimpMessageHeaderAccessor(Message<?> message)

A constructor for accessing and modifying existing message headers.

This constructor is protected. See factory methods in this class and subclasses.

Method Detail

create	back to summary
public static SimpMessageHeaderAccessor create() Create an instance with `org.springframework.messaging.simp.SimpMessageType` `MESSAGE`.

create	back to summary
public static SimpMessageHeaderAccessor create(SimpMessageType messageType) Create an instance with the given `org.springframework.messaging.simp.SimpMessageType`.

createAccessor	back to summary
protected MessageHeaderAccessor createAccessor(Message<?> message) Overrides org.springframework.messaging.support.MessageHeaderAccessor.createAccessor. Doc from org.springframework.messaging.support.MessageHeaderAccessor.createAccessor. Build a 'nested' accessor for the given message. Parameters message:Message<?> the message to build a new accessor for Returns:MessageHeaderAccessor the nested accessor (typically a specific subclass) Annotations @Override

createAccessor

back to summary

protected MessageHeaderAccessor createAccessor(Message<?> message)

Overrides org.springframework.messaging.support.MessageHeaderAccessor.createAccessor.

Doc from org.springframework.messaging.support.MessageHeaderAccessor.createAccessor.

Build a 'nested' accessor for the given message.

Parameters

message:Message<?>: the message to build a new accessor for

Returns:MessageHeaderAccessor

the nested accessor (typically a specific subclass)

Annotations

@Override

getBaseLogMessage	back to summary
private StringBuilder getBaseLogMessage()

getDestination	back to summary
public String getDestination() Annotations @Nullable

getDestination	back to summary
public static String getDestination(Map<String, Object> headers) Annotations @Nullable

getDetailedLogMessage	back to summary
public String getDetailedLogMessage(Object payload) Overrides org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage. Doc from org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage. Return a more detailed message for logging purposes. Parameters payload:Object the payload that corresponds to the headers. Returns:String the message Annotations @SuppressWarnings:unchecked @Override

getDetailedLogMessage

back to summary

public String getDetailedLogMessage(Object payload)

Overrides org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage.

Doc from org.springframework.messaging.support.MessageHeaderAccessor.getDetailedLogMessage.

Return a more detailed message for logging purposes.

Parameters

payload:Object: the payload that corresponds to the headers.

Returns:String

the message

Annotations

@SuppressWarnings:unchecked
@Override

getHeartbeat	back to summary
public static long[] getHeartbeat(Map<String, Object> headers) Annotations @Nullable

getMessageType	back to summary
public SimpMessageType getMessageType() Annotations @Nullable

getMessageType	back to summary
public static SimpMessageType getMessageType(Map<String, Object> headers) Annotations @Nullable

getSessionAttributes	back to summary
public Map<String, Object> getSessionAttributes() Return the attributes associated with the current session. Annotations @SuppressWarnings:unchecked @Nullable

getSessionAttributes

back to summary

public Map<String, Object> getSessionAttributes()

Return the attributes associated with the current session.

Annotations

@SuppressWarnings:unchecked
@Nullable

getSessionAttributes	back to summary
public static Map<String, Object> getSessionAttributes(Map<String, Object> headers) Annotations @SuppressWarnings:unchecked @Nullable

getSessionId	back to summary
public String getSessionId() Return the id of the current session. Annotations @Nullable

getSessionId

back to summary

public String getSessionId()

Return the id of the current session.

Annotations

@Nullable

getSessionId	back to summary
public static String getSessionId(Map<String, Object> headers) Annotations @Nullable

getShortLogMessage	back to summary
public String getShortLogMessage(Object payload) Overrides org.springframework.messaging.support.MessageHeaderAccessor.getShortLogMessage. Doc from org.springframework.messaging.support.MessageHeaderAccessor.getShortLogMessage. Return a concise message for logging purposes. Parameters payload:Object the payload that corresponds to the headers. Returns:String the message Annotations @Override

getShortLogMessage

back to summary

public String getShortLogMessage(Object payload)

Overrides org.springframework.messaging.support.MessageHeaderAccessor.getShortLogMessage.

Doc from org.springframework.messaging.support.MessageHeaderAccessor.getShortLogMessage.

Return a concise message for logging purposes.

Parameters

payload:Object: the payload that corresponds to the headers.

Returns:String

the message

Annotations

@Override

getSubscriptionId	back to summary
public String getSubscriptionId() Annotations @Nullable

getSubscriptionId	back to summary
public static String getSubscriptionId(Map<String, Object> headers) Annotations @Nullable

getUser	back to summary
public Principal getUser() Return the user associated with the current session. Annotations @Nullable

getUser

back to summary

public Principal getUser()

Return the user associated with the current session.

Annotations

@Nullable

getUser	back to summary
public static Principal getUser(Map<String, Object> headers) Annotations @Nullable

setDestination	back to summary
public void setDestination(String destination)

setMessageTypeIfNotSet	back to summary
public void setMessageTypeIfNotSet(SimpMessageType messageType)

setSessionAttributes	back to summary
public void setSessionAttributes(Map<String, Object> attributes) A static alternative for access to the session attributes header.

setSessionId	back to summary
public void setSessionId(String sessionId)

setSubscriptionId	back to summary
public void setSubscriptionId(String subscriptionId)

setUser	back to summary
public void setUser(Principal principal)

setUserChangeCallback back to summary

setUserChangeCallback	back to summary
public void setUserChangeCallback(Consumer<Principal> callback) Provide a callback to be invoked if and when `setUser(Principal)` is called. This is used internally on the inbound channel to detect token-based authentications through an interceptor. Parameters callback:Consumer<Principal> the callback to invoke Since 5.1.9

public void setUserChangeCallback(Consumer<Principal> callback)

Provide a callback to be invoked if and when setUser(Principal) is called. This is used internally on the inbound channel to detect token-based authentications through an interceptor.

Parameters

callback:Consumer<Principal>: the callback to invoke

Since

5.1.9

wrap	back to summary
public static SimpMessageHeaderAccessor wrap(Message<?> message) Create an instance by copying the headers of a Message.

public Class SimpMessageHeaderAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail