Class SessionDisconnectEvent
java.lang.Object
java.util.EventObject
org.springframework.context.ApplicationEvent
org.springframework.web.socket.messaging.AbstractSubProtocolEvent
org.springframework.web.socket.messaging.SessionDisconnectEvent
- All Implemented Interfaces:
Serializable
Event raised when the session of a WebSocket client using a Simple Messaging
Protocol (for example, STOMP) as the WebSocket sub-protocol is closed.
Note that this event may be raised more than once for a single session and therefore event consumers should be idempotent and ignore a duplicate event.
- Since:
- 4.0.3
- Author:
- Rossen Stoyanchev
- See Also:
-
Field Summary
Fields inherited from class EventObject
source
-
Constructor Summary
ConstructorsConstructorDescriptionSessionDisconnectEvent
(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus) Create a new SessionDisconnectEvent.SessionDisconnectEvent
(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus, @Nullable Principal user) Create a new SessionDisconnectEvent. -
Method Summary
Modifier and TypeMethodDescriptionReturn the status with which the session was closed.Return the session id.toString()
Methods inherited from class AbstractSubProtocolEvent
getMessage, getUser
Methods inherited from class ApplicationEvent
getTimestamp
Methods inherited from class EventObject
getSource
-
Constructor Details
-
SessionDisconnectEvent
public SessionDisconnectEvent(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus) Create a new SessionDisconnectEvent.- Parameters:
source
- the component that published the event (nevernull
)message
- the message (nevernull
)sessionId
- the disconnect messagecloseStatus
- the status object
-
SessionDisconnectEvent
public SessionDisconnectEvent(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus, @Nullable Principal user) Create a new SessionDisconnectEvent.- Parameters:
source
- the component that published the event (nevernull
)message
- the message (nevernull
)sessionId
- the disconnect messagecloseStatus
- the status objectuser
- the current session user
-
-
Method Details
-
getSessionId
Return the session id. -
getCloseStatus
Return the status with which the session was closed. -
toString
- Overrides:
toString
in classAbstractSubProtocolEvent
-