javax.websocket.server
Class ServerEndpointConfigurator

java.lang.Object
  javax.websocket.server.ServerEndpointConfigurator

public abstract class ServerEndpointConfigurator
extends Object

The ServerEndpointConfigurator interface may be implemented by developers who want to provide custom configuration algorithms, such as intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each endpoint instance configured with this configurator. The implementation must provide a platform default configurator loading using the service loader.

Constructor Summary

ServerEndpointConfigurator()

Method Summary

boolean	checkOrigin(String originHeaderValue) Check the value of the Origin header (See Origin Header) the client passed during the opening handshake.
List<Extension>	getNegotiatedExtensions(List<Extension> installed, List<Extension> requested) Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none.
String	getNegotiatedSubprotocol(List<String> supported, List<String> requested) Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked.
boolean	matchesURI(String path, URI requestUri, Map<String,String> templateExpansion) Answers whether the incoming handshake request uri matches the path of the server endpoint.
void	modifyHandshake(ServerEndpointConfiguration sec, HandshakeRequest request, HandshakeResponse response) Called by the container after it has formulated a handshake response resulting from a well-formed handshake request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerEndpointConfigurator

public ServerEndpointConfigurator()

Method Detail

getNegotiatedSubprotocol

public String getNegotiatedSubprotocol(List<String> supported,
                                       List<String> requested)

Return the subprotocol the server endpoint has chosen from the requested list supplied by a client who wishes to connect, or none if there wasn't one this server endpoint liked. See Sending the Server's Opening Handshake. Subclasses may provide custom algorithms based on other factors.

The default platform implementation of this method returns the first subprotocol in the list sent by the client that the server supports, or the empty string if there isn't one.

Parameters:

requested - the requested subprotocols from the client endpoint

supported - the subprotocols supported by the server endpoint

Returns:

the negotiated subprotocol or the empty string if there isn't one.

getNegotiatedExtensions

public List<Extension> getNegotiatedExtensions(List<Extension> installed,
                                               List<Extension> requested)

Return the ordered list of extensions that t server endpoint will support given the requested extension list passed in, the empty list if none. See Negotiating Extensions

The default platform implementation of this method returns a list containing all of the requested extensions passed to this method that it supports, using the order in the requested extensions, the empty list if none.

Parameters:

installed - the installed extensions on the implementation.

requested - the requested extensions, in the order they were requested by the client

Returns:

the list of extensions negotiated, the empty list if none.

checkOrigin

public boolean checkOrigin(String originHeaderValue)

Check the value of the Origin header (See Origin Header) the client passed during the opening handshake.

The platform default implementation of this method makes a check of the validity of the Origin header sent along with the opening handshake following the recommendation at: Sending the Server's Opening Handshake.

Parameters:

originHeaderValue - the value of the origin header passed by the client.

Returns:

whether the check passed or not

matchesURI

public boolean matchesURI(String path,
                          URI requestUri,
                          Map<String,String> templateExpansion)

Answers whether the incoming handshake request uri matches the path of the server endpoint. This method may be overridden by implementations with any number of algorithms for determining a match. If the path is a URI-template, and the implementation of this method determines there is a match of some kind, the implementation must add the path variable and values to the template expansion map passed into this method.

The platform default implementation matches the incoming uri to the configuration's path if and only if it is an exact match in the case the path is a URI, and if and only if it is a valid URI-template expansion of the path, in the case where the path is a URI template. In this latter case, all the path variables and values are added to the template expansion map.

Parameters:

templateExpansion - an empty Map to hold URI-template expansion names and values.

path - the path (URI or URI template) of the server endpoint

requestUri - the uri of the incoming handshake.

Returns:

whether there was a match

modifyHandshake

public void modifyHandshake(ServerEndpointConfiguration sec,
                            HandshakeRequest request,
                            HandshakeResponse response)

Called by the container after it has formulated a handshake response resulting from a well-formed handshake request. The container has already has already checked that this configuration has a matching URI, determined the validity of the origin using the checkOrigin method, and filled out the negotiated subprotocols and extensions based on this configuration. Custom configurations may override this method in order to inspect the request parameters and modify the handshake response that the server has formulated. and the URI checking also.

If the developer does not override this method, no further modification of the request and response are made by the implementation.

Parameters:

request - the opening handshake request.

response - the proposed opening handshake response