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

Interface WebSocketNegotiator

All Superinterfaces:

Configuration.Customizer

All Known Implementing Classes:

CreatorNegotiator, WebSocketNegotiator.AbstractNegotiator

public interface WebSocketNegotiator
extends Configuration.Customizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WebSocketNegotiator.AbstractNegotiator

Method Summary

Modifier and Type	Method	Description
default void	customize(Configuration configurable)
static WebSocketNegotiator	from(WebSocketCreator creator, FrameHandlerFactory factory)
static WebSocketNegotiator	from(WebSocketCreator creator, FrameHandlerFactory factory, Configuration.Customizer customizer)
FrameHandler	negotiate(ServerUpgradeRequest request, ServerUpgradeResponse response, Callback callback)	Creates a FrameHandler from the incoming request.

Method Details

negotiate

FrameHandler negotiate(ServerUpgradeRequest request,
 ServerUpgradeResponse response,
 Callback callback)

Creates a FrameHandler from the incoming request.

If the negotiator returns null it is responsible for completing the Callback and sending a response. If the negotiator intends to return non-null FrameHandler, it MUST NOT write content to the response or complete the Callback, but it may modify the response headers.

Parameters:

request - the request details

response - the response details

callback - the callback, should only be completed by the creator if a null WebSocket object is returned.

Returns:

the FrameHandler, or null to take responsibility to send error response if no WebSocket is to be created.

from

static WebSocketNegotiator from(WebSocketCreator creator,
 FrameHandlerFactory factory)

from

static WebSocketNegotiator from(WebSocketCreator creator,
 FrameHandlerFactory factory,
 Configuration.Customizer customizer)

customize

default void customize(Configuration configurable)

Specified by:

customize in interface Configuration.Customizer