public static class ServerEndpointConfig.Configurator extends Object
Constructor and Description |
---|
Configurator() |
Modifier and Type | Method and Description |
---|---|
boolean |
checkOrigin(String originHeaderValue)
Check the value of the Origin header (See Origin Header) the client passed during the opening
handshake.
|
<T> T |
getEndpointInstance(Class<T> endpointClass)
This method is called by the container each time a new client
connects to the logical endpoint this configurator configures.
|
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.
|
void |
modifyHandshake(ServerEndpointConfig sec,
HandshakeRequest request,
HandshakeResponse response)
Called by the container after it has formulated a handshake response resulting from
a well-formed handshake request.
|
public String getNegotiatedSubprotocol(List<String> supported, List<String> requested)
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.
requested
- the requested subprotocols from the client endpointsupported
- the subprotocols supported by the server endpointpublic List<Extension> getNegotiatedExtensions(List<Extension> installed, List<Extension> requested)
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.
installed
- the installed extensions on the implementation.requested
- the requested extensions, in the order they were
requested by the clientpublic boolean checkOrigin(String originHeaderValue)
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.
originHeaderValue
- the value of the origin header passed
by the client.public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response)
If the developer does not override this method, no further modification of the request and response are made by the implementation.
sec
- the configuration object involved in the handshakerequest
- the opening handshake request.response
- the proposed opening handshake responsepublic <T> T getEndpointInstance(Class<T> endpointClass) throws InstantiationException
T
- the type of the endpointendpointClass
- the class of the endpointInstantiationException
- if there was an error producing the
endpoint instance.Copyright © 2017 JBoss by Red Hat. All rights reserved.