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

public Class HandshakerSelector

extends Object
implements Handshaker
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.websocket.core.server.Handshaker
Imports
org.eclipse.jetty.server.Request, .Response, org.eclipse.jetty.util.Callback, org.eclipse.jetty.websocket.core.Configuration, .WebSocketComponents, org.eclipse.jetty.websocket.core.exception.WebSocketException, org.eclipse.jetty.websocket.core.server.Handshaker, .WebSocketNegotiator
Selects between the two Handshaker implementations, RFC6455 (HTTP/1.1 WebSocket Upgrades) and RFC68441 (HTTP/2 WebSocket Upgrades)

Field Summary

Modifier and TypeField and Description
private final RFC6455Handshaker
rfc6455

private final RFC8441Handshaker
rfc8441

Constructor Summary

AccessConstructor and Description
public
HandshakerSelector()

Method Summary

Modifier and TypeMethod and Description
public boolean
isWebSocketUpgradeRequest(Request
the request
request)

Implements org.eclipse.jetty.websocket.core.server.Handshaker.isWebSocketUpgradeRequest.

A preliminary check to see if a request is likely to be a valid WebSocket Upgrade Request.

public boolean
upgradeRequest(WebSocketNegotiator
the negotiator
negotiator, Request
the request
request, Response
the response
response, Callback
the callback
callback, WebSocketComponents
the WebSocket components
components, Configuration.Customizer
the customizer
defaultCustomizer)

Implements org.eclipse.jetty.websocket.core.server.Handshaker.upgradeRequest.

Attempts to upgrade a request to WebSocket.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

rfc6455back to summary
private final RFC6455Handshaker rfc6455
rfc8441back to summary
private final RFC8441Handshaker rfc8441

Constructor Detail

HandshakerSelectorback to summary
public HandshakerSelector()

Method Detail

isWebSocketUpgradeRequestback to summary
public boolean isWebSocketUpgradeRequest(Request request)

Implements org.eclipse.jetty.websocket.core.server.Handshaker.isWebSocketUpgradeRequest.

Doc from org.eclipse.jetty.websocket.core.server.Handshaker.isWebSocketUpgradeRequest.

A preliminary check to see if a request is likely to be a valid WebSocket Upgrade Request. If this returns true the Request may be a valid upgrade request, but if this returns false returns false you can avoid calling upgradeRequest(WebSocketNegotiator, Request, Response, Callback, WebSocketComponents, Configuration.Customizer) entirely as it will always fail

Parameters
request:Request

the request

Returns:boolean

true if the request is thought to be a valid websocket upgrade request.

Annotations
@Override
upgradeRequestback to summary
public boolean upgradeRequest(WebSocketNegotiator negotiator, Request request, Response response, Callback callback, WebSocketComponents components, Configuration.Customizer defaultCustomizer) throws WebSocketException

Implements org.eclipse.jetty.websocket.core.server.Handshaker.upgradeRequest.

Doc from org.eclipse.jetty.websocket.core.server.Handshaker.upgradeRequest.

Attempts to upgrade a request to WebSocket.

Returns true if the WebSocket upgrade is successful and a successful response is generated and the callback eventually completed, or if the WebSocket upgrade failed and a failure response is generated and the callback eventually completed. Returns false if a response is not generated and the caller is responsible for generating a response and completing the callback.

Parameters
negotiator:WebSocketNegotiator

the negotiator

request:Request

the request

response:Response

the response

callback:Callback

the callback

components:WebSocketComponents

the WebSocket components

defaultCustomizer:Configuration.Customizer

the customizer

Returns:boolean

true if a response was generated, false if a response is not generated

Annotations
@Override
Exceptions
WebSocketException:
there is an error during the upgrade