Spring Framework 6.1.4 · org.springframework.web.socket.adapter.AbstractWebSocketSession

Modifier and Type	Field and Description
private final Map<String, Object>	attributes
protected static final IdGenerator	idGenerator
protected static final Log	logger
private T	nativeSession

Access	Constructor and Description
public	AbstractWebSocketSession(Map<String, Object> the attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used. attributes) Create a new instance and associate the given attributes with it.

Method Summary

Modifier and Type	Method and Description
protected final void	checkNativeSessionInitialized()
public final void	close() Implements org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with status 1000, i.e. equivalent to: session.close(CloseStatus.NORMAL);
public final void	close(CloseStatus status) Implements org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with the given close status.
protected abstract void	closeInternal(CloseStatus status)
public Map<String, Object>	getAttributes() Implements org.springframework.web.socket.WebSocketSession.getAttributes. Return the map with attributes associated with the WebSocket session.
public T	getNativeSession() Implements org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession. Return the underlying native WebSocketSession.
public <R> R	getNativeSession(Class<R> the required type of the session requiredType) Implements org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession. Return the underlying native WebSocketSession, if available.
public void	initializeNativeSession(T session)
protected abstract void	sendBinaryMessage(BinaryMessage message)
public final void	sendMessage(WebSocketMessage<?> message) Implements org.springframework.web.socket.WebSocketSession.sendMessage. Send a WebSocket message: either `TextMessage` or `BinaryMessage`.
protected abstract void	sendPingMessage(PingMessage message)
protected abstract void	sendPongMessage(PongMessage message)
protected abstract void	sendTextMessage(TextMessage message)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

attributes	back to summary
private final Map<String, Object> attributes

idGenerator	back to summary
protected static final IdGenerator idGenerator

logger	back to summary
protected static final Log logger

nativeSession	back to summary
private T nativeSession Annotations @Nullable

AbstractWebSocketSession	back to summary
public AbstractWebSocketSession(Map<String, Object> attributes) Create a new instance and associate the given attributes with it. Parameters attributes:Map<String, Object> the attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.

Method Detail

checkNativeSessionInitialized	back to summary
protected final void checkNativeSessionInitialized()

close	back to summary
public final void close() throws IOException Implements org.springframework.web.socket.WebSocketSession.close. Doc from org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with status 1000, i.e. equivalent to: session.close(CloseStatus.NORMAL); Annotations @Override Exceptions IOException: Doc from java.io.Closeable.close. if an I/O error occurs

back to summary

public final void close() throws IOException

Implements org.springframework.web.socket.WebSocketSession.close.

Doc from org.springframework.web.socket.WebSocketSession.close.

Close the WebSocket connection with status 1000, i.e. equivalent to:

session.close(CloseStatus.NORMAL);

Annotations

@Override

Exceptions

IOException:

Doc from java.io.Closeable.close.

if an I/O error occurs

close	back to summary
public final void close(CloseStatus status) throws IOException Implements org.springframework.web.socket.WebSocketSession.close. Doc from org.springframework.web.socket.WebSocketSession.close. Close the WebSocket connection with the given close status. Annotations @Override

back to summary

public final void close(CloseStatus status) throws IOException

Implements org.springframework.web.socket.WebSocketSession.close.

Doc from org.springframework.web.socket.WebSocketSession.close.

Close the WebSocket connection with the given close status.

Annotations

@Override

closeInternal	back to summary
protected abstract void closeInternal(CloseStatus status) throws IOException

getAttributes back to summary

getAttributes	back to summary
public Map<String, Object> getAttributes() Implements org.springframework.web.socket.WebSocketSession.getAttributes. Doc from org.springframework.web.socket.WebSocketSession.getAttributes. Return the map with attributes associated with the WebSocket session. On the server side the map can be populated initially through a `HandshakeInterceptor`. On the client side the map can be populated via `WebSocketClient` handshake methods. Returns:Map<String, Object> a Map with the session attributes (never `null`) Annotations @Override

public Map<String, Object> getAttributes()

Implements org.springframework.web.socket.WebSocketSession.getAttributes.

Doc from org.springframework.web.socket.WebSocketSession.getAttributes.

Return the map with attributes associated with the WebSocket session.

On the server side the map can be populated initially through a HandshakeInterceptor. On the client side the map can be populated via WebSocketClient handshake methods.

Returns:Map<String, Object>

a Map with the session attributes (never null)

Annotations

@Override

getNativeSession	back to summary
public T getNativeSession() Implements org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession. Doc from org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession. Return the underlying native WebSocketSession. Annotations @Override

getNativeSession

back to summary

public T getNativeSession()

Implements org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession.

Doc from org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession.

Return the underlying native WebSocketSession.

Annotations

@Override

getNativeSession back to summary

getNativeSession	back to summary
public <R> R getNativeSession(Class<R> requiredType) Implements org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession. Doc from org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession. Return the underlying native WebSocketSession, if available. Parameters requiredType:Class<R> the required type of the session Returns:R the native session of the required type, or `null` if not available Annotations @SuppressWarnings:unchecked @Override @Nullable

public <R> R getNativeSession(Class<R> requiredType)

Implements org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession.

Doc from org.springframework.web.socket.adapter.NativeWebSocketSession.getNativeSession.

Return the underlying native WebSocketSession, if available.

Parameters

requiredType:Class<R>: the required type of the session

Returns:R

the native session of the required type, or null if not available

Annotations

@SuppressWarnings:unchecked
@Override
@Nullable

initializeNativeSession	back to summary
public void initializeNativeSession(T session)

sendBinaryMessage	back to summary
protected abstract void sendBinaryMessage(BinaryMessage message) throws IOException

sendMessage back to summary

sendMessage	back to summary
public final void sendMessage(WebSocketMessage<?> message) throws IOException Implements org.springframework.web.socket.WebSocketSession.sendMessage. Doc from org.springframework.web.socket.WebSocketSession.sendMessage. Send a WebSocket message: either `TextMessage` or `BinaryMessage`. Note The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore, sending must be synchronized. To ensure that, one option is to wrap the `WebSocketSession` with the `ConcurrentWebSocketSessionDecorator`. Annotations @Override

public final void sendMessage(WebSocketMessage<?> message) throws IOException

Implements org.springframework.web.socket.WebSocketSession.sendMessage.

Doc from org.springframework.web.socket.WebSocketSession.sendMessage.

Send a WebSocket message: either TextMessage or BinaryMessage.

Note

The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore, sending must be synchronized. To ensure that, one option is to wrap the WebSocketSession with the ConcurrentWebSocketSessionDecorator.

Annotations

@Override

sendPingMessage	back to summary
protected abstract void sendPingMessage(PingMessage message) throws IOException

sendPongMessage	back to summary
protected abstract void sendPongMessage(PongMessage message) throws IOException

sendTextMessage	back to summary
protected abstract void sendTextMessage(TextMessage message) throws IOException

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class AbstractWebSocketSession<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail