Package io.undertow.websockets.jsr

Class WebSocketDeploymentInfo

java.lang.Object

io.undertow.websockets.jsr.WebSocketDeploymentInfo

public class WebSocketDeploymentInfo
extends Object

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	addEndpoint(Class<?> annotated)
WebSocketDeploymentInfo	addEndpoint(javax.websocket.server.ServerEndpointConfig endpoint)
WebSocketDeploymentInfo	addExtension(ExtensionHandshake extension)	Add a new WebSocket Extension into this deployment info.
WebSocketDeploymentInfo	addListener(WebSocketDeploymentInfo.ContainerReadyListener listener)
List<Class<?>>	getAnnotatedEndpoints()
ByteBufferPool	getBuffers()
String	getClientBindAddress()
List<ExtensionHandshake>	getExtensions()
List<javax.websocket.server.ServerEndpointConfig>	getProgramaticEndpoints()
WebSocketReconnectHandler	getReconnectHandler()
org.xnio.XnioWorker	getWorker()
boolean	isDispatchToWorkerThread()
WebSocketDeploymentInfo	setBuffers(ByteBufferPool buffers)
WebSocketDeploymentInfo	setBuffers(org.xnio.Pool<ByteBuffer> buffers)	Deprecated.
void	setClientBindAddress(String clientBindAddress)
WebSocketDeploymentInfo	setDispatchToWorkerThread(boolean dispatchToWorkerThread)
WebSocketDeploymentInfo	setReconnectHandler(WebSocketReconnectHandler reconnectHandler)
WebSocketDeploymentInfo	setWorker(org.xnio.XnioWorker worker)

Methods inherited from class java.lang.Object

clone, 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 org.xnio.XnioWorker getWorker()

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)

addEndpoint

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

getAnnotatedEndpoints

public List<Class<?>> getAnnotatedEndpoints()

getProgramaticEndpoints

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

addListener

public WebSocketDeploymentInfo addListener(WebSocketDeploymentInfo.ContainerReadyListener listener)

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

getExtensions

public List<ExtensionHandshake> getExtensions()

Returns:

list of extensions available for this deployment info

getClientBindAddress

public String getClientBindAddress()

setClientBindAddress

public void setClientBindAddress(String clientBindAddress)

getReconnectHandler

public WebSocketReconnectHandler getReconnectHandler()

setReconnectHandler

public WebSocketDeploymentInfo setReconnectHandler(WebSocketReconnectHandler reconnectHandler)