Package io.undertow.websockets

Class WebSocketDeploymentInfo

java.lang.Object

io.undertow.websockets.WebSocketDeploymentInfo

All Implemented Interfaces:

Cloneable

public class WebSocketDeploymentInfo
extends Object
implements Cloneable

Web socket deployment information

Author:

Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebSocketDeploymentInfo.ContainerReadyListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor	Description
WebSocketDeploymentInfo()

Method Summary

Modifier and Type	Method	Description
WebSocketDeploymentInfo	addAnnotatedEndpoints(Collection<Class<?>> annotatedEndpoints)
WebSocketDeploymentInfo	addEndpoint(jakarta.websocket.server.ServerEndpointConfig endpoint)
WebSocketDeploymentInfo	addEndpoint(Class<?> annotated)
WebSocketDeploymentInfo	addListener(WebSocketDeploymentInfo.ContainerReadyListener listener)
WebSocketDeploymentInfo	addListeners(Collection<WebSocketDeploymentInfo.ContainerReadyListener> listeners)
WebSocketDeploymentInfo	addProgramaticEndpoints(Collection<jakarta.websocket.server.ServerEndpointConfig> programaticEndpoints)
WebSocketDeploymentInfo	addServerExtension(io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker extension)	Add a new WebSocket Extension into this deployment info.
WebSocketDeploymentInfo	addServerExtensions(Collection<io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker> extensions)
WebSocketDeploymentInfo	clone()
List<Class<?>>	getAnnotatedEndpoints()
String	getClientBindAddress()
Supplier<Principal>	getCurrentUserSupplier()
io.netty.channel.EventLoopGroup	getEventLoopGroup()
Supplier<Executor>	getExecutor()
List<WebSocketDeploymentInfo.ContainerReadyListener>	getListeners()
int	getMaxFrameSize()
List<jakarta.websocket.server.ServerEndpointConfig>	getProgramaticEndpoints()
WebSocketReconnectHandler	getReconnectHandler()
List<io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker>	getServerExtensions()
boolean	isDispatchToWorkerThread()
WebSocketDeploymentInfo	setClientBindAddress(String clientBindAddress)
WebSocketDeploymentInfo	setCurrentUserSupplier(Supplier<Principal> currentUserSupplier)
WebSocketDeploymentInfo	setDispatchToWorkerThread(boolean dispatchToWorkerThread)
WebSocketDeploymentInfo	setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)
WebSocketDeploymentInfo	setExecutor(Supplier<Executor> executor)
WebSocketDeploymentInfo	setMaxFrameSize(int maxFrameSize)
WebSocketDeploymentInfo	setReconnectHandler(WebSocketReconnectHandler reconnectHandler)

Methods inherited from class java.lang.Object

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

Field Details

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

• Constant Field Values

Constructor Details

WebSocketDeploymentInfo

public WebSocketDeploymentInfo()

Method Details

addEndpoint

public WebSocketDeploymentInfo addEndpoint(Class<?> annotated)

addAnnotatedEndpoints

public WebSocketDeploymentInfo addAnnotatedEndpoints(Collection<Class<?>> annotatedEndpoints)

addEndpoint

public WebSocketDeploymentInfo addEndpoint(jakarta.websocket.server.ServerEndpointConfig endpoint)

addProgramaticEndpoints

public WebSocketDeploymentInfo addProgramaticEndpoints(Collection<jakarta.websocket.server.ServerEndpointConfig> programaticEndpoints)

getEventLoopGroup

public io.netty.channel.EventLoopGroup getEventLoopGroup()

getExecutor

public Supplier<Executor> getExecutor()

setExecutor

public WebSocketDeploymentInfo setExecutor(Supplier<Executor> executor)

setEventLoopGroup

public WebSocketDeploymentInfo setEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)

getAnnotatedEndpoints

public List<Class<?>> getAnnotatedEndpoints()

getProgramaticEndpoints

public List<jakarta.websocket.server.ServerEndpointConfig> getProgramaticEndpoints()

addListener

public WebSocketDeploymentInfo addListener(WebSocketDeploymentInfo.ContainerReadyListener listener)

addListeners

public WebSocketDeploymentInfo addListeners(Collection<WebSocketDeploymentInfo.ContainerReadyListener> listeners)

getListeners

public List<WebSocketDeploymentInfo.ContainerReadyListener> getListeners()

isDispatchToWorkerThread

public boolean isDispatchToWorkerThread()

setDispatchToWorkerThread

public WebSocketDeploymentInfo setDispatchToWorkerThread(boolean dispatchToWorkerThread)

getMaxFrameSize

public int getMaxFrameSize()

setMaxFrameSize

public WebSocketDeploymentInfo setMaxFrameSize(int maxFrameSize)

addServerExtension

public WebSocketDeploymentInfo addServerExtension(io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker extension)

Add a new WebSocket Extension into this deployment info.

Parameters:

extension - a new ExtensionHandshake instance

Returns:

current deployment info

addServerExtensions

public WebSocketDeploymentInfo addServerExtensions(Collection<io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker> extensions)

getServerExtensions

public List<io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker> getServerExtensions()

Returns:

list of extensions available for this deployment info

getClientBindAddress

public String getClientBindAddress()

setClientBindAddress

public WebSocketDeploymentInfo setClientBindAddress(String clientBindAddress)

getReconnectHandler

public WebSocketReconnectHandler getReconnectHandler()

setReconnectHandler

public WebSocketDeploymentInfo setReconnectHandler(WebSocketReconnectHandler reconnectHandler)

getCurrentUserSupplier

public Supplier<Principal> getCurrentUserSupplier()

setCurrentUserSupplier

public WebSocketDeploymentInfo setCurrentUserSupplier(Supplier<Principal> currentUserSupplier)

clone

public WebSocketDeploymentInfo clone()

Overrides:

clone in class Object