Top Fields Constructors Methods
org.eclipse.jetty.websocket.core.server.internal

public abstract Class WebSocketNegotiation

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.jetty.websocket.core.server.internal.RFC6455Negotiation, org.eclipse.jetty.websocket.core.server.internal.RFC8441Negotiation
Imports
java.util.ArrayList, .Collections, .List, .Set, java.util.stream.Collectors, org.eclipse.jetty.http.BadMessageException, .HttpField, .QuotedCSV, org.eclipse.jetty.server.Request, .Response, org.eclipse.jetty.util.Callback, org.eclipse.jetty.websocket.core.ExtensionConfig, .WebSocketComponents, org.eclipse.jetty.websocket.core.server.ServerUpgradeRequest, .ServerUpgradeResponse

Field Summary

Modifier and TypeField and Description
private final Callback
callback

private final WebSocketComponents
components

private List<ExtensionConfig>
negotiatedExtensions

private List<ExtensionConfig>
offeredExtensions

private List<String>
offeredProtocols

private String
protocol

private final ServerUpgradeRequest
request

private final ServerUpgradeResponse
response

private String
version

Constructor Summary

AccessConstructor and Description
public
WebSocketNegotiation(Request request, Response response, Callback callback, WebSocketComponents webSocketComponents)

Method Summary

Modifier and TypeMethod and Description
public Callback
getCallback()

public List<ExtensionConfig>
getNegotiatedExtensions()

public List<ExtensionConfig>
getOfferedExtensions()

public List<String>
getOfferedSubprotocols()

public ServerUpgradeRequest
getRequest()

public ServerUpgradeResponse
getResponse()

public String
getSubprotocol()

public String
getVersion()

public WebSocketComponents
getWebSocketComponents()

public void
negotiate()

protected void
negotiateHeaders(Request baseRequest)

public void
setNegotiatedExtensions(List<ExtensionConfig> extensions)

public void
setSubprotocol(String protocol)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public abstract boolean
validateHeaders()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

callbackback to summary
private final Callback callback
componentsback to summary
private final WebSocketComponents components
negotiatedExtensionsback to summary
private List<ExtensionConfig> negotiatedExtensions
offeredExtensionsback to summary
private List<ExtensionConfig> offeredExtensions
offeredProtocolsback to summary
private List<String> offeredProtocols
protocolback to summary
private String protocol
requestback to summary
private final ServerUpgradeRequest request
responseback to summary
private final ServerUpgradeResponse response
versionback to summary
private String version

Constructor Detail

WebSocketNegotiationback to summary
public WebSocketNegotiation(Request request, Response response, Callback callback, WebSocketComponents webSocketComponents)

Method Detail

getCallbackback to summary
public Callback getCallback()
getNegotiatedExtensionsback to summary
public List<ExtensionConfig> getNegotiatedExtensions()
getOfferedExtensionsback to summary
public List<ExtensionConfig> getOfferedExtensions()
getOfferedSubprotocolsback to summary
public List<String> getOfferedSubprotocols()
getRequestback to summary
public ServerUpgradeRequest getRequest()
getResponseback to summary
public ServerUpgradeResponse getResponse()
getSubprotocolback to summary
public String getSubprotocol()
getVersionback to summary
public String getVersion()
getWebSocketComponentsback to summary
public WebSocketComponents getWebSocketComponents()
negotiateback to summary
public void negotiate() throws BadMessageException
negotiateHeadersback to summary
protected void negotiateHeaders(Request baseRequest)
setNegotiatedExtensionsback to summary
public void setNegotiatedExtensions(List<ExtensionConfig> extensions)
setSubprotocolback to summary
public void setSubprotocol(String protocol)
toStringback 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
validateHeadersback to summary
public abstract boolean validateHeaders()