Package org.eclipse.jetty.websocket.core.server.internal

Class AbstractHandshaker

java.lang.Object

org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker

All Implemented Interfaces:

Handshaker

Direct Known Subclasses:

RFC6455Handshaker, RFC8441Handshaker

public abstract class AbstractHandshaker
extends Object
implements Handshaker

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
AbstractHandshaker()

Method Summary

Modifier and Type	Method	Description
protected abstract WebSocketConnection	createWebSocketConnection(Request baseRequest, WebSocketCoreSession coreSession)
boolean	isWebSocketUpgradeRequest(Request request)	A preliminary check to see if a request is likely to be a valid WebSocket Upgrade Request.
protected abstract WebSocketNegotiation	newNegotiation(Request request, Response response, Callback callback, WebSocketComponents webSocketComponents)
protected WebSocketConnection	newWebSocketConnection(EndPoint endPoint, Executor executor, Scheduler scheduler, ByteBufferPool byteBufferPool, WebSocketCoreSession coreSession)
protected WebSocketCoreSession	newWebSocketCoreSession(Request request, FrameHandler handler, Negotiated negotiated, WebSocketComponents components)
protected abstract void	prepareResponse(Response response, WebSocketNegotiation negotiation)
boolean	upgradeRequest(WebSocketNegotiator negotiator, Request request, Response response, Callback callback, WebSocketComponents components, Configuration.Customizer defaultCustomizer)	Attempts to upgrade a request to WebSocket.
protected boolean	validateNegotiation(WebSocketNegotiation negotiation)

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final org.slf4j.Logger LOG

Constructor Details

AbstractHandshaker

public AbstractHandshaker()

Method Details

upgradeRequest

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

Description copied from interface: Handshaker

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.

Specified by:

upgradeRequest in interface Handshaker

Parameters:

negotiator - the negotiator

request - the request

response - the response

callback - the callback

components - the WebSocket components

defaultCustomizer - the customizer

Returns:

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

Throws:

WebSocketException - there is an error during the upgrade

newNegotiation

protected abstract WebSocketNegotiation newNegotiation(Request request,
 Response response,
 Callback callback,
 WebSocketComponents webSocketComponents)

isWebSocketUpgradeRequest

public boolean isWebSocketUpgradeRequest(Request request)

Description copied from interface: Handshaker

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 Handshaker.upgradeRequest(WebSocketNegotiator, Request, Response, Callback, WebSocketComponents, Configuration.Customizer) entirely as it will always fail

Specified by:

isWebSocketUpgradeRequest in interface Handshaker

Parameters:

request - the request

Returns:

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

validateNegotiation

protected boolean validateNegotiation(WebSocketNegotiation negotiation)

newWebSocketCoreSession

protected WebSocketCoreSession newWebSocketCoreSession(Request request,
 FrameHandler handler,
 Negotiated negotiated,
 WebSocketComponents components)

createWebSocketConnection

protected abstract WebSocketConnection createWebSocketConnection(Request baseRequest,
 WebSocketCoreSession coreSession)

newWebSocketConnection

protected WebSocketConnection newWebSocketConnection(EndPoint endPoint,
 Executor executor,
 Scheduler scheduler,
 ByteBufferPool byteBufferPool,
 WebSocketCoreSession coreSession)

prepareResponse

protected abstract void prepareResponse(Response response,
 WebSocketNegotiation negotiation)