Top Description Interfaces Annotations Classes
[default module]

Package javax.websocket.server

This package contains all the WebSocket APIs used only by server side applications.

Interface Summary

Modifier and TypeInterface and Description
public interface
HandshakeRequest

The handshake request represents the web socket defined Http GET request for the opening handshake of a web socket session.

public interface
ServerApplicationConfig

Developers include implementations of ServerApplicationConfig in an archive containing websocket endpoints (WAR file, or JAR file within the WAR file) in order to specify the websocket endpoints within the archive the implementation must deploy.

public interface
ServerContainer

The ServerContainer is the specialized view of the WebSocketContainer available in server-side deployments.

public interface
ServerEndpointConfig

The ServerEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints.

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
PathParam

This annotation may be used to annotate method parameters on server endpoints where a URI-template has been used in the path-mapping of the ServerEndpoint annotation.

public @interface
ServerEndpoint

This class level annotation declares that the class it decorates is a web socket endpoint that will be deployed and made available in the URI-space of a web socket server.

Class Summary

Modifier and TypeClass and Description
pack-priv class
DefaultServerEndpointConfig

The DefaultServerEndpointConfig is a concrete class that embodies all the configuration parameters for an endpoint that is to be published as a server endpoint.