Interface ServerContainer
- All Superinterfaces:
WebSocketContainer
For websocket enabled web containers, developers may
obtain a reference to the ServerContainer instance by retrieving it as an
attribute named javax.websocket.server.ServerContainer
on the
ServletContext. This way, the registration methods held on this interface
may be called to register server endpoints from a ServletContextListener
during the deployment of the WAR file containing the endpoint.
WebSocket implementations that run outside the web container may have other means by which to provide a ServerContainer instance to the developer at application deployment time.
Once the application deployment phase is complete, and the websocket application has begun accepting incoming connections, the registration methods may no longer be called.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addEndpoint
(Class<?> endpointClass) Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application.void
addEndpoint
(ServerEndpointConfig serverConfig) Methods inherited from interface javax.websocket.WebSocketContainer
connectToServer, connectToServer, connectToServer, connectToServer, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize
-
Method Details
-
addEndpoint
Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application.- Parameters:
endpointClass
- the class of the annotated endpoint- Throws:
DeploymentException
- if the annotated endpoint was badly formed.IllegalStateException
- if the containing websocket application has already been deployed.
-
addEndpoint
- Parameters:
serverConfig
- the configuration instance representing the logical endpoint that will be registered.- Throws:
DeploymentException
- if the endpoint was badly formed.IllegalStateException
- if the containing websocket application has already been deployed.
-