javax.websocket.server
Interface ServerApplicationConfiguration

public interface ServerApplicationConfiguration

Developers may include implementations of ServerApplicationConfiguration in an archive containing websocket endpoints (WAR file, or JAR file within the WAR file) in order to specify precisely which of the websocket endpoints within the archive the implementation must deploy. There is a separate method for programmatic endpoints and for annotated endpoints.

Author:

dannycoward

Method Summary

Set<Class<?>>	getAnnotatedEndpointClasses(Set<Class<?>> scanned) Return a set of annotated endpoint classes that the server container must deploy.
Set<Class<? extends ServerEndpointConfiguration>>	getEndpointConfigurationClasses(Set<Class<? extends ServerEndpointConfiguration>> scanned) Return a set of ServerEndpointConfiguration classes that the server container must deploy.

Method Detail

getEndpointConfigurationClasses

Set<Class<? extends ServerEndpointConfiguration>> getEndpointConfigurationClasses(Set<Class<? extends ServerEndpointConfiguration>> scanned)

Return a set of ServerEndpointConfiguration classes that the server container must deploy. The set of ServerEndpointConfiguration passed in to this method is the set obtained by scanning the archive containing the implementation of this interface. Therefore, this set passed in contains all the ServerEndpointConfiguration classes in the JAR or WAR file containing the implementation of this interface. This set passed in may be used the build the set to return to the container for deployment.

Parameters:

scanned - the set of all the ServerEndpointConfiguration classes in the archive containing the implementation of this interface.

Returns:

the set of ServerEndpointConfiguration to deploy on the server.

getAnnotatedEndpointClasses

Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned)

Return a set of annotated endpoint classes that the server container must deploy. The set of classes passed in to this method is the set obtained by scanning the archive containing the implementation of this interface. Therefore, this set passed in contains all the annotated endpoint classes in the JAR or WAR file containing the implementation of this interface. This set passed in may be used the build the set to return to the container for deployment.

Parameters:

scanned - the set of all the annotated endpoint classes in the archive containing the implementation of this interface.

Returns:

the set of annotated endpoint classes to deploy on the server.