org.springframework.web.socket.adapter

Class AbstractWebSocketSesssionAdapter<T>

java.lang.Object

org.springframework.web.socket.adapter.AbstractWebSocketSesssionAdapter<T>

All Implemented Interfaces:

ConfigurableWebSocketSession, WebSocketSession

Direct Known Subclasses:

JettyWebSocketSessionAdapter, StandardWebSocketSessionAdapter

public abstract class AbstractWebSocketSesssionAdapter<T>
extends java.lang.Object
implements ConfigurableWebSocketSession

An abstract base class for implementations of WebSocketSession.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger

Constructor Summary

Constructors

Constructor and Description
AbstractWebSocketSesssionAdapter()

Method Summary

Modifier and Type	Method and Description
void	close() Close the WebSocket connection with status 1000, i.e.
void	close(CloseStatus status) Close the WebSocket connection with the given close status.
protected abstract void	closeInternal(CloseStatus status)
abstract void	initSession(T session)
protected abstract void	sendBinaryMessage(BinaryMessage message)
void	sendMessage(WebSocketMessage message) Send a WebSocket message either TextMessage or BinaryMessage.
protected abstract void	sendTextMessage(TextMessage message)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.socket.adapter.ConfigurableWebSocketSession

setPrincipal, setRemoteAddress, setRemoteHostName, setUri

Methods inherited from interface org.springframework.web.socket.WebSocketSession

getId, getPrincipal, getRemoteAddress, getRemoteHostName, getUri, isOpen, isSecure

Field Detail

logger

protected final Log logger

Constructor Detail

AbstractWebSocketSesssionAdapter

public AbstractWebSocketSesssionAdapter()

Method Detail

initSession

public abstract void initSession(T session)

sendMessage

public final void sendMessage(WebSocketMessage message)
                       throws java.io.IOException

Description copied from interface: WebSocketSession

Send a WebSocket message either TextMessage or BinaryMessage.

Specified by:

sendMessage in interface WebSocketSession

Throws:

java.io.IOException

sendTextMessage

protected abstract void sendTextMessage(TextMessage message)
                                 throws java.io.IOException

Throws:

java.io.IOException

sendBinaryMessage

protected abstract void sendBinaryMessage(BinaryMessage message)
                                   throws java.io.IOException

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: WebSocketSession

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

 session.close(CloseStatus.NORMAL);
 

Specified by:

close in interface WebSocketSession

Throws:

java.io.IOException

close

public final void close(CloseStatus status)
                 throws java.io.IOException

Description copied from interface: WebSocketSession

Close the WebSocket connection with the given close status.

Specified by:

close in interface WebSocketSession

Throws:

java.io.IOException

closeInternal

protected abstract void closeInternal(CloseStatus status)
                               throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object