Spring Framework 6.1.4 · org.springframework.web.socket.adapter.jetty.JettyWebSocketSession

Modifier and Type	Class and Description
private static interface	JettyWebSocketSession.SessionConsumer

Modifier and Type	Field and Description
private String	acceptedProtocol
private List<WebSocketExtension>	extensions
private HttpHeaders	headers
private final String	id
private URI	uri
private Principal	user

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	JettyWebSocketSession(Map<String, Object> the attributes from the HTTP handshake to associate with the WebSocket session attributes) Create a new `JettyWebSocketSession` instance.
public	JettyWebSocketSession(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, Principal the user associated with the session; if `null` we'll fall back on the user available via `org.eclipse.jetty.websocket.api.Session#getUpgradeRequest()` user) Create a new `JettyWebSocketSession` instance associated with the given user.

public

JettyWebSocketSession(Map<String, Object>

the attributes from the HTTP handshake to associate with the WebSocket session

attributes)

Create a new JettyWebSocketSession instance.

public

JettyWebSocketSession(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, Principal

the user associated with the session; if null we'll fall back on the user available via org.eclipse.jetty.websocket.api.Session#getUpgradeRequest()

user)

Create a new JettyWebSocketSession instance associated with the given user.

Method Summary

Modifier and Type	Method and Description
protected void	closeInternal(CloseStatus status) Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.closeInternal.
public String	getAcceptedProtocol() Implements org.springframework.web.socket.WebSocketSession.getAcceptedProtocol. Return the negotiated sub-protocol.
public int	getBinaryMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit. Get the configured maximum size for an incoming binary message.
public List<WebSocketExtension>	getExtensions() Implements org.springframework.web.socket.WebSocketSession.getExtensions. Determine the negotiated extensions.
private List<WebSocketExtension>	getExtensions(Session session)
public HttpHeaders	getHandshakeHeaders() Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Return the headers used in the handshake request (never `null`).
public String	getId() Implements org.springframework.web.socket.WebSocketSession.getId. Return a unique session identifier.
public InetSocketAddress	getLocalAddress() Implements org.springframework.web.socket.WebSocketSession.getLocalAddress. Return the address on which the request was received.
public Principal	getPrincipal() Implements org.springframework.web.socket.WebSocketSession.getPrincipal. Return a `java.security.Principal` instance containing the name of the authenticated user.
public InetSocketAddress	getRemoteAddress() Implements org.springframework.web.socket.WebSocketSession.getRemoteAddress. Return the address of the remote client.
public int	getTextMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit. Get the configured maximum size for an incoming text message.
public URI	getUri() Implements org.springframework.web.socket.WebSocketSession.getUri. Return the URI used to open the WebSocket connection.
public void	initializeNativeSession(Session session) Overrides org.springframework.web.socket.adapter.AbstractWebSocketSession.initializeNativeSession.
public boolean	isOpen() Implements org.springframework.web.socket.WebSocketSession.isOpen. Whether the underlying connection is open.
protected void	sendBinaryMessage(BinaryMessage message) Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendBinaryMessage.
protected void	sendPingMessage(PingMessage message) Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendPingMessage.
protected void	sendPongMessage(PongMessage message) Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendPongMessage.
protected void	sendTextMessage(TextMessage message) Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendTextMessage.
public void	setBinaryMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit. Configure the maximum size for an incoming binary message.
public void	setTextMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit. Configure the maximum size for an incoming text message.
private void	useSession(JettyWebSocketSession.SessionConsumer sessionConsumer)

Inherited from org.springframework.web.socket.adapter.AbstractWebSocketSession:: checkNativeSessionInitialized close close getAttributes getNativeSession getNativeSession sendMessage toString

Field Detail

acceptedProtocol	back to summary
private String acceptedProtocol Annotations @Nullable

extensions	back to summary
private List<WebSocketExtension> extensions Annotations @Nullable

headers	back to summary
private HttpHeaders headers Annotations @Nullable

id	back to summary
private final String id

uri	back to summary
private URI uri Annotations @Nullable

user	back to summary
private Principal user Annotations @Nullable

Constructor Detail

JettyWebSocketSession back to summary

JettyWebSocketSession	back to summary
public JettyWebSocketSession(Map<String, Object> attributes) Create a new `JettyWebSocketSession` instance. Parameters attributes:Map<String, Object> the attributes from the HTTP handshake to associate with the WebSocket session

public JettyWebSocketSession(Map<String, Object> attributes)

Create a new JettyWebSocketSession instance.

Parameters

attributes:Map<String, Object>: the attributes from the HTTP handshake to associate with the WebSocket session

JettyWebSocketSession back to summary

JettyWebSocketSession	back to summary
public JettyWebSocketSession(Map<String, Object> attributes, Principal user) Create a new `JettyWebSocketSession` instance associated with the given user. 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. user:Principal the user associated with the session; if `null` we'll fall back on the user available via `org.eclipse.jetty.websocket.api.Session#getUpgradeRequest()`

public JettyWebSocketSession(Map<String, Object> attributes, Principal user)

Create a new JettyWebSocketSession instance associated with the given user.

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.
user:Principal: the user associated with the session; if null we'll fall back on the user available via org.eclipse.jetty.websocket.api.Session#getUpgradeRequest()

Method Detail

closeInternal	back to summary
protected void closeInternal(CloseStatus status) throws IOException Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.closeInternal. Annotations @Override

closeInternal

back to summary

protected void closeInternal(CloseStatus status) throws IOException

Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.closeInternal.

Annotations

@Override

getAcceptedProtocol back to summary

getAcceptedProtocol	back to summary
public String getAcceptedProtocol() Implements org.springframework.web.socket.WebSocketSession.getAcceptedProtocol. Doc from org.springframework.web.socket.WebSocketSession.getAcceptedProtocol. Return the negotiated sub-protocol. Returns:String the protocol identifier, or `null` if no protocol was specified or negotiated successfully Annotations @Override

public String getAcceptedProtocol()

Implements org.springframework.web.socket.WebSocketSession.getAcceptedProtocol.

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

Return the negotiated sub-protocol.

Returns:String

the protocol identifier, or null if no protocol was specified or negotiated successfully

Annotations

@Override

getBinaryMessageSizeLimit	back to summary
public int getBinaryMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit. Get the configured maximum size for an incoming binary message. Annotations @Override

getBinaryMessageSizeLimit

back to summary

public int getBinaryMessageSizeLimit()

Implements org.springframework.web.socket.WebSocketSession.getBinaryMessageSizeLimit.

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

Get the configured maximum size for an incoming binary message.

Annotations

@Override

getExtensions	back to summary
public List<WebSocketExtension> getExtensions() Implements org.springframework.web.socket.WebSocketSession.getExtensions. Doc from org.springframework.web.socket.WebSocketSession.getExtensions. Determine the negotiated extensions. Returns:List<WebSocketExtension> the list of extensions, or an empty list if no extension was specified or negotiated successfully Annotations @Override

getExtensions

back to summary

public List<WebSocketExtension> getExtensions()

Implements org.springframework.web.socket.WebSocketSession.getExtensions.

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

Determine the negotiated extensions.

Returns:List<WebSocketExtension>

the list of extensions, or an empty list if no extension was specified or negotiated successfully

Annotations

@Override

getExtensions	back to summary
private List<WebSocketExtension> getExtensions(Session session)

getHandshakeHeaders back to summary

getHandshakeHeaders	back to summary
public HttpHeaders getHandshakeHeaders() Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Doc from org.springframework.web.socket.WebSocketSession.getHandshakeHeaders. Return the headers used in the handshake request (never `null`). Annotations @Override

public HttpHeaders getHandshakeHeaders()

Implements org.springframework.web.socket.WebSocketSession.getHandshakeHeaders.

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

Return the headers used in the handshake request (never null).

Annotations

@Override

getId	back to summary
public String getId() Implements org.springframework.web.socket.WebSocketSession.getId. Doc from org.springframework.web.socket.WebSocketSession.getId. Return a unique session identifier. Annotations @Override

getId

back to summary

public String getId()

Implements org.springframework.web.socket.WebSocketSession.getId.

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

Return a unique session identifier.

Annotations

@Override

getLocalAddress	back to summary
public InetSocketAddress getLocalAddress() Implements org.springframework.web.socket.WebSocketSession.getLocalAddress. Doc from org.springframework.web.socket.WebSocketSession.getLocalAddress. Return the address on which the request was received. Annotations @Override

getLocalAddress

back to summary

public InetSocketAddress getLocalAddress()

Implements org.springframework.web.socket.WebSocketSession.getLocalAddress.

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

Return the address on which the request was received.

Annotations

@Override

getPrincipal back to summary

getPrincipal	back to summary
public Principal getPrincipal() Implements org.springframework.web.socket.WebSocketSession.getPrincipal. Doc from org.springframework.web.socket.WebSocketSession.getPrincipal. Return a `java.security.Principal` instance containing the name of the authenticated user. If the user has not been authenticated, the method returns `null`. Annotations @Override

public Principal getPrincipal()

Implements org.springframework.web.socket.WebSocketSession.getPrincipal.

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

Return a java.security.Principal instance containing the name of the authenticated user.

If the user has not been authenticated, the method returns null.

Annotations

@Override

getRemoteAddress	back to summary
public InetSocketAddress getRemoteAddress() Implements org.springframework.web.socket.WebSocketSession.getRemoteAddress. Doc from org.springframework.web.socket.WebSocketSession.getRemoteAddress. Return the address of the remote client. Annotations @Override

getRemoteAddress

back to summary

public InetSocketAddress getRemoteAddress()

Implements org.springframework.web.socket.WebSocketSession.getRemoteAddress.

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

Return the address of the remote client.

Annotations

@Override

getTextMessageSizeLimit	back to summary
public int getTextMessageSizeLimit() Implements org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit. Get the configured maximum size for an incoming text message. Annotations @Override

getTextMessageSizeLimit

back to summary

public int getTextMessageSizeLimit()

Implements org.springframework.web.socket.WebSocketSession.getTextMessageSizeLimit.

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

Get the configured maximum size for an incoming text message.

Annotations

@Override

getUri	back to summary
public URI getUri() Implements org.springframework.web.socket.WebSocketSession.getUri. Doc from org.springframework.web.socket.WebSocketSession.getUri. Return the URI used to open the WebSocket connection. Annotations @Override @Nullable

getUri

back to summary

public URI getUri()

Implements org.springframework.web.socket.WebSocketSession.getUri.

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

Return the URI used to open the WebSocket connection.

Annotations

@Override
@Nullable

initializeNativeSession	back to summary
public void initializeNativeSession(Session session) Overrides org.springframework.web.socket.adapter.AbstractWebSocketSession.initializeNativeSession. Annotations @Override

initializeNativeSession

back to summary

public void initializeNativeSession(Session session)

Overrides org.springframework.web.socket.adapter.AbstractWebSocketSession.initializeNativeSession.

Annotations

@Override

isOpen	back to summary
public boolean isOpen() Implements org.springframework.web.socket.WebSocketSession.isOpen. Doc from org.springframework.web.socket.WebSocketSession.isOpen. Whether the underlying connection is open. Annotations @Override

isOpen

back to summary

public boolean isOpen()

Implements org.springframework.web.socket.WebSocketSession.isOpen.

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

Whether the underlying connection is open.

Annotations

@Override

sendBinaryMessage	back to summary
protected void sendBinaryMessage(BinaryMessage message) throws IOException Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendBinaryMessage. Annotations @Override

sendBinaryMessage

back to summary

protected void sendBinaryMessage(BinaryMessage message) throws IOException

Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendBinaryMessage.

Annotations

@Override

sendPingMessage	back to summary
protected void sendPingMessage(PingMessage message) throws IOException Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendPingMessage. Annotations @Override

sendPingMessage

back to summary

protected void sendPingMessage(PingMessage message) throws IOException

Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendPingMessage.

Annotations

@Override

sendPongMessage	back to summary
protected void sendPongMessage(PongMessage message) throws IOException Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendPongMessage. Annotations @Override

sendPongMessage

back to summary

protected void sendPongMessage(PongMessage message) throws IOException

Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendPongMessage.

Annotations

@Override

sendTextMessage	back to summary
protected void sendTextMessage(TextMessage message) throws IOException Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendTextMessage. Annotations @Override

sendTextMessage

back to summary

protected void sendTextMessage(TextMessage message) throws IOException

Implements abstract org.springframework.web.socket.adapter.AbstractWebSocketSession.sendTextMessage.

Annotations

@Override

setBinaryMessageSizeLimit	back to summary
public void setBinaryMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit. Configure the maximum size for an incoming binary message. Annotations @Override

setBinaryMessageSizeLimit

back to summary

public void setBinaryMessageSizeLimit(int messageSizeLimit)

Implements org.springframework.web.socket.WebSocketSession.setBinaryMessageSizeLimit.

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

Configure the maximum size for an incoming binary message.

Annotations

@Override

setTextMessageSizeLimit	back to summary
public void setTextMessageSizeLimit(int messageSizeLimit) Implements org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit. Doc from org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit. Configure the maximum size for an incoming text message. Annotations @Override

setTextMessageSizeLimit

back to summary

public void setTextMessageSizeLimit(int messageSizeLimit)

Implements org.springframework.web.socket.WebSocketSession.setTextMessageSizeLimit.

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

Configure the maximum size for an incoming text message.

Annotations