public class HandshakeInfo extends Object
WebSocketSession
session.WebSocketSession.getHandshakeInfo()
Constructor and Description |
---|
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol)
Constructor with basic information about the handshake.
|
HandshakeInfo(URI uri,
HttpHeaders headers,
reactor.core.publisher.Mono<Principal> principal,
String protocol,
InetSocketAddress remoteAddress,
Map<String,Object> attributes,
String logPrefix)
Constructor targetting server-side use with extra information about the
handshake, the remote address, and a pre-existing log prefix for
correlation.
|
Modifier and Type | Method and Description |
---|---|
Map<String,Object> |
getAttributes()
Attributes extracted from the handshake request to be added to the
WebSocket session.
|
HttpHeaders |
getHeaders()
Return the handshake HTTP headers.
|
String |
getLogPrefix()
A log prefix used in the handshake to correlate log messages, if any.
|
reactor.core.publisher.Mono<Principal> |
getPrincipal()
Return the principal associated with the handshake HTTP request.
|
InetSocketAddress |
getRemoteAddress()
For a server-side session this is the remote address where the handshake
request came from.
|
String |
getSubProtocol()
The sub-protocol negotiated at handshake time, or
null if none. |
URI |
getUri()
Return the URL for the WebSocket endpoint.
|
String |
toString() |
public HandshakeInfo(URI uri, HttpHeaders headers, reactor.core.publisher.Mono<Principal> principal, @Nullable String protocol)
uri
- the endpoint URLheaders
- request headers for server or response headers or clientprincipal
- the principal for the sessionprotocol
- the negotiated sub-protocol (may be null
)public HandshakeInfo(URI uri, HttpHeaders headers, reactor.core.publisher.Mono<Principal> principal, @Nullable String protocol, @Nullable InetSocketAddress remoteAddress, Map<String,Object> attributes, @Nullable String logPrefix)
uri
- the endpoint URLheaders
- request headers for server or response headers or clientprincipal
- the principal for the sessionprotocol
- the negotiated sub-protocol (may be null
)remoteAddress
- the remote address where the handshake came fromattributes
- initial attributes to use for the WebSocket sessionlogPrefix
- log prefix used during the handshake for correlating log
messages, if any.public URI getUri()
public HttpHeaders getHeaders()
public reactor.core.publisher.Mono<Principal> getPrincipal()
@Nullable public String getSubProtocol()
null
if none.@Nullable public InetSocketAddress getRemoteAddress()
public Map<String,Object> getAttributes()
@Nullable public String getLogPrefix()
null
if not specified