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

public final Class RFC6455Handshaker

extends AbstractHandshaker
Class Inheritance
Imports
org.eclipse.jetty.http.BadMessageException, .HttpField, .HttpFields, .HttpHeader, .HttpMethod, .HttpStatus, .HttpVersion, .PreEncodedHttpField, org.eclipse.jetty.io.ByteBufferPool, org.eclipse.jetty.server.ConnectionMetaData, .Connector, .Request, .Response, org.eclipse.jetty.util.Callback, org.eclipse.jetty.websocket.core.WebSocketComponents, .WebSocketConnection, .WebSocketCoreSession, org.eclipse.jetty.websocket.core.util.WebSocketUtils

Field Summary

Modifier and TypeField and Description
private static final HttpField
CONNECTION_UPGRADE

private static final HttpField
UPGRADE_WEBSOCKET

Inherited from org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker:
LOG

Constructor Summary

AccessConstructor and Description
public
RFC6455Handshaker()

Method Summary

Modifier and TypeMethod and Description
protected WebSocketConnection
createWebSocketConnection(Request baseRequest, WebSocketCoreSession coreSession)

Implements abstract org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker.createWebSocketConnection.

public boolean
isWebSocketUpgradeRequest(Request
the request
request)

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

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.

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

Implements abstract org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker.newNegotiation.

protected void
prepareResponse(Response response, WebSocketNegotiation negotiation)

Implements abstract org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker.prepareResponse.

protected boolean
validateNegotiation(WebSocketNegotiation negotiation)

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

Inherited from org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker:
newWebSocketConnectionnewWebSocketCoreSessionupgradeRequest

Field Detail

CONNECTION_UPGRADEback to summary
private static final HttpField CONNECTION_UPGRADE
UPGRADE_WEBSOCKETback to summary
private static final HttpField UPGRADE_WEBSOCKET

Constructor Detail

RFC6455Handshakerback to summary
public RFC6455Handshaker()

Method Detail

createWebSocketConnectionback to summary
protected WebSocketConnection createWebSocketConnection(Request baseRequest, WebSocketCoreSession coreSession)

Implements abstract org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker.createWebSocketConnection.

Annotations
@Override
isWebSocketUpgradeRequestback to summary
public boolean isWebSocketUpgradeRequest(Request request)

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

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
newNegotiationback to summary
protected WebSocketNegotiation newNegotiation(Request request, Response response, Callback callback, WebSocketComponents webSocketComponents)

Implements abstract org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker.newNegotiation.

Annotations
@Override
prepareResponseback to summary
protected void prepareResponse(Response response, WebSocketNegotiation negotiation)

Implements abstract org.eclipse.jetty.websocket.core.server.internal.AbstractHandshaker.prepareResponse.

Annotations
@Override
validateNegotiationback to summary
protected boolean validateNegotiation(WebSocketNegotiation negotiation)

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

Annotations
@Override