Top Inners Methods
org.eclipse.jetty.websocket.core.server

public Interface WebSocketNegotiator

extends Customizer
Known Direct Implementers
org.eclipse.jetty.websocket.core.server.WebSocketNegotiator.AbstractNegotiator
Imports
org.eclipse.jetty.util.Callback, org.eclipse.jetty.websocket.core.Configuration, .FrameHandler, org.eclipse.jetty.websocket.core.server.internal.CreatorNegotiator

Nested and Inner Type Summary

Modifier and TypeClass and Description
public abstract static class
WebSocketNegotiator.AbstractNegotiator

Method Summary

Modifier and TypeMethod and Description
public default void
customize(Configuration configurable)

Implements org.eclipse.jetty.websocket.core.Configuration.Customizer.customize.

public static WebSocketNegotiator
from(WebSocketCreator creator, FrameHandlerFactory factory)

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

public FrameHandler

Returns:

the FrameHandler, or null to take responsibility to send error response if no WebSocket is to be created.
negotiate(ServerUpgradeRequest
the request details
request, ServerUpgradeResponse
the response details
response, Callback
the callback, should only be completed by the creator if a null WebSocket object is returned.
callback)

Creates a FrameHandler from the incoming request.

Method Detail

customizeback to summary
public default void customize(Configuration configurable)

Implements org.eclipse.jetty.websocket.core.Configuration.Customizer.customize.

Annotations
@Override
fromback to summary
public static WebSocketNegotiator from(WebSocketCreator creator, FrameHandlerFactory factory)
fromback to summary
public static WebSocketNegotiator from(WebSocketCreator creator, FrameHandlerFactory factory, Configuration.Customizer customizer)
negotiateback to summary
public 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:ServerUpgradeRequest

the request details

response:ServerUpgradeResponse

the response details

callback:Callback

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

Returns:FrameHandler

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

org.eclipse.jetty.websocket.core.server back to summary

public abstract Class WebSocketNegotiator.AbstractNegotiator

extends ConfigurationCustomizer
implements WebSocketNegotiator
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.websocket.core.server.WebSocketNegotiator, org.eclipse.jetty.websocket.core.Configuration.Customizer
Known Direct Subclasses
org.eclipse.jetty.websocket.core.server.internal.CreatorNegotiator

Field Summary

Modifier and TypeField and Description
pack-priv final Configuration.Customizer
customizer

Constructor Summary

AccessConstructor and Description
public
AbstractNegotiator()

public
AbstractNegotiator(Configuration.Customizer customizer)

Method Summary

Modifier and TypeMethod and Description
public void
customize(Configuration configurable)

Overrides org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer.customize.

Overrides default org.eclipse.jetty.websocket.core.server.WebSocketNegotiator.customize.

Implements org.eclipse.jetty.websocket.core.Configuration.Customizer.customize.

Inherited from org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer:
getIdleTimeoutgetInputBufferSizegetMaxBinaryMessageSizegetMaxFrameSizegetMaxOutgoingFramesgetMaxTextMessageSizegetOutputBufferSizegetWriteTimeoutisAutoFragmentsetAutoFragmentsetIdleTimeoutsetInputBufferSizesetMaxBinaryMessageSizesetMaxFrameSizesetMaxOutgoingFramessetMaxTextMessageSizesetOutputBufferSizesetWriteTimeouttoString

Field Detail

customizerback to summary
pack-priv final Configuration.Customizer customizer

Constructor Detail

AbstractNegotiatorback to summary
public AbstractNegotiator()
AbstractNegotiatorback to summary
public AbstractNegotiator(Configuration.Customizer customizer)

Method Detail

customizeback to summary
public void customize(Configuration configurable)

Overrides org.eclipse.jetty.websocket.core.Configuration.ConfigurationCustomizer.customize.

Overrides default org.eclipse.jetty.websocket.core.server.WebSocketNegotiator.customize.

Implements org.eclipse.jetty.websocket.core.Configuration.Customizer.customize.

Annotations
@Override