Package org.glassfish.tyrus.core

Class TyrusWebSocketEngine

java.lang.Object

org.glassfish.tyrus.core.TyrusWebSocketEngine

All Implemented Interfaces:

WebSocketEngine

public class TyrusWebSocketEngine
extends Object
implements WebSocketEngine

WebSocketEngine implementation, which handles server-side handshake, validation and data processing.

Author:

Alexey Stashok, Pavel Bucek

See Also:

• TyrusWebSocket
• TyrusEndpointWrapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	TyrusWebSocketEngine builder.

Nested classes/interfaces inherited from interface org.glassfish.tyrus.spi.WebSocketEngine

WebSocketEngine.UpgradeInfo, WebSocketEngine.UpgradeStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCOMING_BUFFER_SIZE	Maximum size of incoming buffer in bytes.
static final String	MAX_SESSIONS_PER_APP	Maximum number of open sessions per server application.
static final String	MAX_SESSIONS_PER_REMOTE_ADDR	Maximum number of open sessions per unique remote address.
static final String	PARALLEL_BROADCAST_ENABLED	Parallel broadcast support.
static String	THREAD_FACTORY	Defines the ThreadFactory to be used by internal default Executor Services.
static final String	TRACING_THRESHOLD	Property used for configuring tracing threshold.
static final String	TRACING_TYPE	Property used for configuring the type of tracing supported by the server.
static final String	USE_VIRTUAL_THREADS	Defines whether the virtual threads should be used by internal Executor Services in Tyrus on JDK 21+ when not using an exact number of threads by FixedThreadPool.
static final String	WSADL_SUPPORT	Wsadl support.

Method Summary

Modifier and Type	Method	Description
static TyrusWebSocketEngine.TyrusWebSocketEngineBuilder	builder(WebSocketContainer webSocketContainer)	Create TyrusWebSocketEngine.TyrusWebSocketEngineBuilder instance based on passed WebSocketContainer.
ApplicationEventListener	getApplicationEventListener()	Get ApplicationEventListener related to current TyrusWebSocketEngine instance.
Application	getWsadlApplication()	Get Application representing current set of deployed endpoints.
void	register(ServerEndpointConfig serverConfig, String contextPath)	Register ServerEndpointConfig.
void	register(Class<?> endpointClass, String contextPath)	Register endpoint class.
void	setIncomingBufferSize(int incomingBufferSize)	Deprecated. Please use .TyrusWebSocketEngineBuilder#incomingBufferSize(Integer) instead.
void	unregister(TyrusEndpointWrapper endpointWrapper)	Un-registers the specified TyrusEndpointWrapper with the WebSocketEngine.
WebSocketEngine.UpgradeInfo	upgrade(UpgradeRequest request, UpgradeResponse response)	A transport calls this method to upgrade a HTTP request.

Methods inherited from class java.lang.Object

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

Field Details

INCOMING_BUFFER_SIZE

public static final String INCOMING_BUFFER_SIZE

Maximum size of incoming buffer in bytes.

The value must be Integer or its primitive alternative.

Default value is 4194315, which means that TyrusWebSocketEngine is by default capable of processing messages up to 4 MB.

See Also:

• Constant Field Values

MAX_SESSIONS_PER_APP

public static final String MAX_SESSIONS_PER_APP

Maximum number of open sessions per server application.

The value must be positive Integer or its primitive alternative. Negative values and zero are ignored.

The number of open sessions per application is not limited by default.

See Also:

• Constant Field Values

MAX_SESSIONS_PER_REMOTE_ADDR

public static final String MAX_SESSIONS_PER_REMOTE_ADDR

Maximum number of open sessions per unique remote address.

The value must be positive Integer or its primitive alternative. Negative values and zero are ignored.

The number of open sessions per remote address is not limited by default.

See Also:

• Constant Field Values

TRACING_TYPE

public static final String TRACING_TYPE

Property used for configuring the type of tracing supported by the server.

The value is expected to be string value of DebugContext.TracingType.

The default value is DebugContext.TracingType.OFF.

See Also:

• Constant Field Values

TRACING_THRESHOLD

public static final String TRACING_THRESHOLD

Property used for configuring tracing threshold.

The value is expected to be string value of DebugContext.TracingThreshold.

The default value is DebugContext.TracingThreshold.SUMMARY.

See Also:

• Constant Field Values

WSADL_SUPPORT

@Beta
public static final String WSADL_SUPPORT

Wsadl support.

Wsadl is experimental feature which exposes endpoint configuration in form of XML file, similarly as Wadl for REST services. Currently generated Wsadl contains only set of endpoints and their endpoint paths. Wsadl is exposed on URI ending by "application.wsadl".

The value must be string, "true" means that the feature is enable, "false" that the feature is disabled.

Default value is "false";

See Also:

• Constant Field Values

PARALLEL_BROADCAST_ENABLED

public static final String PARALLEL_BROADCAST_ENABLED

Parallel broadcast support.

TyrusSession.broadcast(String) and .TyrusSession#broadcast(java.nio.ByteBuffer) operations are by default executed in parallel. The parallel execution of broadcast can be disabled by setting this server property to false.

Expected value is true or false and the default value is false.

See Also:

• TyrusSession.broadcast(String)
• TyrusSession.broadcast(java.nio.ByteBuffer)
• Constant Field Values

THREAD_FACTORY

public static String THREAD_FACTORY

Defines the ThreadFactory to be used by internal default Executor Services.

Since:

2.0.8

USE_VIRTUAL_THREADS

public static final String USE_VIRTUAL_THREADS

Defines whether the virtual threads should be used by internal Executor Services in Tyrus on JDK 21+ when not using an exact number of threads by FixedThreadPool.

The default is false for this version of Tyrus.

Since:

2.0.8

See Also:

• Constant Field Values

Method Details

builder

public static TyrusWebSocketEngine.TyrusWebSocketEngineBuilder builder(WebSocketContainer webSocketContainer)

Create TyrusWebSocketEngine.TyrusWebSocketEngineBuilder instance based on passed WebSocketContainer.

Parameters:

webSocketContainer - WebSocketContainer instance. Cannot be null.

Returns:

new builder.

upgrade

public WebSocketEngine.UpgradeInfo upgrade(UpgradeRequest request,
 UpgradeResponse response)

Description copied from interface: WebSocketEngine

A transport calls this method to upgrade a HTTP request.

Specified by:

upgrade in interface WebSocketEngine

Parameters:

request - request to be upgraded.

response - response to the upgrade request.

Returns:

info about upgrade status and connection details.

setIncomingBufferSize

public void setIncomingBufferSize(int incomingBufferSize)

Deprecated.

Please use .TyrusWebSocketEngineBuilder#incomingBufferSize(Integer) instead.

Set incoming buffer size.

Parameters:

incomingBufferSize - buffer size in bytes.

register

public void register(Class<?> endpointClass,
 String contextPath)
              throws DeploymentException

Description copied from interface: WebSocketEngine

Register endpoint class.

Specified by:

register in interface WebSocketEngine

Parameters:

endpointClass - endpoint class to be registered.

contextPath - context path of the registered endpoint.

Throws:

DeploymentException - when the endpoint is invalid.

register

public void register(ServerEndpointConfig serverConfig,
 String contextPath)
              throws DeploymentException

Description copied from interface: WebSocketEngine

Register ServerEndpointConfig.

Specified by:

register in interface WebSocketEngine

Parameters:

serverConfig - server endpoint to be registered.

contextPath - context path of the registered endpoint.

Throws:

DeploymentException - when the endpoint is invalid.

unregister

public void unregister(TyrusEndpointWrapper endpointWrapper)

Un-registers the specified TyrusEndpointWrapper with the WebSocketEngine.

Parameters:

endpointWrapper - the TyrusEndpointWrapper to un-register.

getApplicationEventListener

public ApplicationEventListener getApplicationEventListener()

Get ApplicationEventListener related to current TyrusWebSocketEngine instance.

Returns:

listener instance.

getWsadlApplication

@Beta
public Application getWsadlApplication()

Get Application representing current set of deployed endpoints.

Returns:

application representing current set of deployed endpoints.