javax.websocket.server
Interface ServerEndpointConfiguration

All Superinterfaces:

EndpointConfiguration

public interface ServerEndpointConfiguration
extends EndpointConfiguration

The ServerEndpointConfiguration is a special kind of endpoint configuration object that contains web socket configuration information specific only to server endpoints. For developers deploying programmatic endpoints, ServerEndpointConfiguration objects can be created using a ServerEndpointConfigurationBuilder.

Since:

DRAFT 001

Author:

dannycoward

Method Summary

Class<?>	getEndpointClass() Returns the Class of the endpoint this configuration is configuring.
List<Extension>	getExtensions() Return the websocket extensions configured.
String	getPath() Return the path for this endpoint configuration.
ServerEndpointConfigurator	getServerEndpointConfigurator() Return the ServerEndpointConfigurator this configuration is using.
List<String>	getSubprotocols() Return the websocket subprotocols configured.

Methods inherited from interface javax.websocket.EndpointConfiguration

getDecoders, getEncoders, getUserProperties

Method Detail

getEndpointClass

Class<?> getEndpointClass()

Returns the Class of the endpoint this configuration is configuring. If the endpoint is an annotated endpoint, the value is the class of the Java class annotated with @ServerEndpoint. if the endpoint is a programmatic, the value is the class of the subclass of Endpoint.

Returns:

the class of the endpoint, annotated or programmatic.

getPath

String getPath()

Return the path for this endpoint configuration. The path is the URI or URI-template relative to the websocket root of the server to which the endpoint using this configuration will be mapped. The path is always non-null and always begins with a leading "/".

Returns:

the relative path for this configuration.

getSubprotocols

List<String> getSubprotocols()

Return the websocket subprotocols configured.

Returns:

the list of subprotocols, the empty list if none

getExtensions

List<Extension> getExtensions()

Return the websocket extensions configured.

Returns:

the list of extensions, the empty list if none.

getServerEndpointConfigurator

ServerEndpointConfigurator getServerEndpointConfigurator()

Return the ServerEndpointConfigurator this configuration is using. If none was set by calling ServerEndpointConfigurationBuilder#setServerEndpointConfigurator(javax.websocket.server.ServerEndpointConfigurator) this methods returns the platform default configurator.

Returns:

the configurator in use.