WebSocket server API 1.1 · javax.websocket.server.ServerContainer

The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments. There is one ServerContainer instance per websocket application. The ServerContainer holds the methods to be able to register server endpoints during the initialization phase of the application.

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.

Modifier and Type	Method and Description
public void	addEndpoint(Class<?> the class of the annotated endpoint endpointClass) Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application.
public void	addEndpoint(ServerEndpointConfig the configuration instance representing the logical endpoint that will be registered. serverConfig)

Method Detail

addEndpoint	back to summary
public void addEndpoint(Class<?> endpointClass) throws DeploymentException Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application. Parameters endpointClass:Class<?> the class of the annotated endpoint Exceptions DeploymentException: if the annotated endpoint was badly formed. IllegalStateException: if the containing websocket application has already been deployed.

addEndpoint

back to summary

public void addEndpoint(Class<?> endpointClass) throws DeploymentException

Deploys the given annotated endpoint into this ServerContainer during the initialization phase of deploying the application.

Parameters

endpointClass:Class<?>: the class of the annotated endpoint

Exceptions

DeploymentException:: if the annotated endpoint was badly formed.
IllegalStateException:: if the containing websocket application has already been deployed.

addEndpoint	back to summary
public void addEndpoint(ServerEndpointConfig serverConfig) throws DeploymentException Parameters serverConfig:ServerEndpointConfig the configuration instance representing the logical endpoint that will be registered. Exceptions DeploymentException: if the endpoint was badly formed. IllegalStateException: if the containing websocket application has already been deployed.

public Interface ServerContainer

Method Summary

Method Detail