Top Fields Constructors Methods
org.eclipse.jetty.ee10.websocket.jakarta.server.internal

public Class JakartaWebSocketCreator

extends Object
implements WebSocketCreator
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.websocket.core.server.WebSocketCreator
Imports
java.util.ArrayList, .HashMap, .List, .Map, .Objects, jakarta.websocket.Extension, .Extension.Parameter, jakarta.websocket.server.ServerEndpointConfig, org.eclipse.jetty.ee10.websocket.jakarta.common.ConfiguredEndpoint, .JakartaWebSocketContainer, .JakartaWebSocketExtension, .ServerEndpointConfigWrapper, org.eclipse.jetty.http.HttpHeader, .HttpStatus, org.eclipse.jetty.http.pathmap.UriTemplatePathSpec, org.eclipse.jetty.server.Request, .Response, org.eclipse.jetty.util.Callback, .StringUtil, org.eclipse.jetty.websocket.core.ExtensionConfig, .WebSocketExtensionRegistry, org.eclipse.jetty.websocket.core.server.ServerUpgradeRequest, .ServerUpgradeResponse, .WebSocketCreator, org.slf4j.Logger, .LoggerFactory

Field Summary

Modifier and TypeField and Description
private final ServerEndpointConfig
private final JakartaWebSocketContainer
private final WebSocketExtensionRegistry
private static final Logger
public static final String
public static final String
public static final String

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Object
createWebSocket(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
)

Implements org.eclipse.jetty.websocket.core.server.WebSocketCreator.createWebSocket.

Create a websocket from the incoming request.

public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

baseConfigback to summary
private final ServerEndpointConfig baseConfig
containerScopeback to summary
private final JakartaWebSocketContainer containerScope
extensionRegistryback to summary
private final WebSocketExtensionRegistry extensionRegistry
LOGback to summary
private static final Logger LOG
PROP_LOCAL_ADDRESSback to summary
public static final String PROP_LOCAL_ADDRESS
PROP_LOCALESback to summary
public static final String PROP_LOCALES
PROP_REMOTE_ADDRESSback to summary
public static final String PROP_REMOTE_ADDRESS

Constructor Detail

JakartaWebSocketCreatorback to summary
public JakartaWebSocketCreator(JakartaWebSocketContainer containerScope, ServerEndpointConfig config, WebSocketExtensionRegistry extensionRegistry)

Method Detail

createWebSocketback to summary
public Object createWebSocket(ServerUpgradeRequest request, ServerUpgradeResponse response, Callback callback)

Implements org.eclipse.jetty.websocket.core.server.WebSocketCreator.createWebSocket.

Doc from org.eclipse.jetty.websocket.core.server.WebSocketCreator.createWebSocket.

Create a websocket from the incoming request.

If the creator returns null it is responsible for completing the Callback and sending a response. But if the creator intends to return non-null WebSocket object, 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:Object

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

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override