org.springframework.web.socket.messaging

Class SessionConnectEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.web.socket.messaging.SessionConnectEvent

All Implemented Interfaces:

Serializable

public class SessionConnectEvent
extends ApplicationEvent

Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g. STOMP) as the WebSocket sub-protocol issues a connect request.

Note that this is not the same as the WebSocket session getting established but rather the client's first attempt to connect within the the sub-protocol, for example sending the STOMP CONNECT frame.

The provided message can be examined to check information about the connected user, The session id, and any headers sent by the client, for STOMP check the class StompHeaderAccessor. For example:

 StompHeaderAccessor headers = StompHeaderAccessor.wrap(message);
 headers.getSessionId();
 headers.getSessionAttributes();
 headers.getPrincipal();
 

Since:

4.0.3

Author:

Rossen Stoyanchev

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
SessionConnectEvent(Object source, Message<byte[]> message) Create a new SessionConnectEvent.

Method Summary

Modifier and Type	Method and Description
Message<byte[]>	getMessage() Return the connect message.
String	toString()

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionConnectEvent

public SessionConnectEvent(Object source,
                           Message<byte[]> message)

Create a new SessionConnectEvent.

Parameters:

source - the component that published the event (never null)

message - the connect message

Method Detail

getMessage

public Message<byte[]> getMessage()

Return the connect message.

toString

public String toString()

Overrides:

toString in class EventObject