org.springframework.web.reactive.socket

Class HandshakeInfo

java.lang.Object

org.springframework.web.reactive.socket.HandshakeInfo

public class HandshakeInfo
extends java.lang.Object

Simple container of information related to the handshake request that started the WebSocketSession session.

Since:

5.0

Author:

Rossen Stoyanchev

See Also:

WebSocketSession.getHandshakeInfo()

Field Summary

Fields

Modifier and Type	Field and Description
private HttpHeaders	headers
private <any>	principalMono
private java.lang.String	protocol
private java.net.URI	uri

Constructor Summary

Constructors

Constructor and Description
HandshakeInfo(java.net.URI uri, HttpHeaders headers, <any> principal, java.lang.String protocol) Constructor with information about the handshake.

Method Summary

Modifier and Type	Method and Description
HttpHeaders	getHeaders() Return the handshake HTTP headers.
<any>	getPrincipal() Return the principal associated with the handshake HTTP request.
java.lang.String	getSubProtocol() The sub-protocol negotiated at handshake time, or null if none.
java.net.URI	getUri() Return the URL for the WebSocket endpoint.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

uri

private final java.net.URI uri

principalMono

private final <any> principalMono

headers

private final HttpHeaders headers

protocol

@Nullable
private final java.lang.String protocol

Constructor Detail

HandshakeInfo

public HandshakeInfo(java.net.URI uri,
                     HttpHeaders headers,
                     <any> principal,
                     @Nullable
                     java.lang.String protocol)

Constructor with information about the handshake.

Parameters:

uri - the endpoint URL

headers - request headers for server or response headers or client

principal - the principal for the session

protocol - the negotiated sub-protocol (may be null)

Method Detail

getUri

public java.net.URI getUri()

Return the URL for the WebSocket endpoint.

getHeaders

public HttpHeaders getHeaders()

Return the handshake HTTP headers. Those are the request headers for a server session and the response headers for a client session.

getPrincipal

public <any> getPrincipal()

Return the principal associated with the handshake HTTP request.

getSubProtocol

@Nullable
public java.lang.String getSubProtocol()

The sub-protocol negotiated at handshake time, or null if none.

See Also:

https://tools.ietf.org/html/rfc6455#section-1.9

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object