Package io.undertow.websockets.jsr

Class WebSocketDeploymentInfo

java.lang.Object

io.undertow.websockets.jsr.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 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	addExtension(ExtensionHandshake extension)	Add a new WebSocket Extension into this deployment info.
WebSocketDeploymentInfo	addExtensions(Collection<ExtensionHandshake> extensions)
WebSocketDeploymentInfo	addListener(WebSocketDeploymentInfo.ContainerReadyListener listener)
WebSocketDeploymentInfo	addListeners(Collection<WebSocketDeploymentInfo.ContainerReadyListener> listeners)
WebSocketDeploymentInfo	addProgramaticEndpoints(Collection<jakarta.websocket.server.ServerEndpointConfig> programaticEndpoints)
WebSocketDeploymentInfo	clone()
List<Class<?>>	getAnnotatedEndpoints()
ByteBufferPool	getBuffers()
String	getClientBindAddress()
List<ExtensionHandshake>	getExtensions()
List<WebSocketDeploymentInfo.ContainerReadyListener>	getListeners()
List<jakarta.websocket.server.ServerEndpointConfig>	getProgramaticEndpoints()
WebSocketReconnectHandler	getReconnectHandler()
Supplier<org.xnio.XnioWorker>	getWorker()
boolean	isDispatchToWorkerThread()
WebSocketDeploymentInfo	setBuffers(ByteBufferPool buffers)
WebSocketDeploymentInfo	setBuffers(org.xnio.Pool<ByteBuffer> buffers)	Deprecated.
WebSocketDeploymentInfo	setClientBindAddress(String clientBindAddress)
WebSocketDeploymentInfo	setDispatchToWorkerThread(boolean dispatchToWorkerThread)
WebSocketDeploymentInfo	setReconnectHandler(WebSocketReconnectHandler reconnectHandler)
WebSocketDeploymentInfo	setWorker(Supplier<org.xnio.XnioWorker> worker)
WebSocketDeploymentInfo	setWorker(org.xnio.XnioWorker worker)

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

Constructor Detail

WebSocketDeploymentInfo

public WebSocketDeploymentInfo()

Method Detail

getWorker

public Supplier<org.xnio.XnioWorker> getWorker()

setWorker

public WebSocketDeploymentInfo setWorker(Supplier<org.xnio.XnioWorker> worker)

setWorker

public WebSocketDeploymentInfo setWorker(org.xnio.XnioWorker worker)

getBuffers

public ByteBufferPool getBuffers()

setBuffers

@Deprecated
public WebSocketDeploymentInfo setBuffers(org.xnio.Pool<ByteBuffer> buffers)

Deprecated.

setBuffers

public WebSocketDeploymentInfo setBuffers(ByteBufferPool buffers)

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)

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)

addExtension

public WebSocketDeploymentInfo addExtension(ExtensionHandshake extension)

Add a new WebSocket Extension into this deployment info.

Parameters:

extension - a new ExtensionHandshake instance

Returns:

current deployment info

addExtensions

public WebSocketDeploymentInfo addExtensions(Collection<ExtensionHandshake> extensions)

getExtensions

public List<ExtensionHandshake> getExtensions()

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)

clone

public WebSocketDeploymentInfo clone()

Overrides:

clone in class Object