Index (Tyrus Container SPI 1.2.1 API)

C D G I O P R S T U

C

checkHandshake(SPIHandshakeRequest) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: This method must be called by the provider during its check for a successful websocket handshake.
close(CloseReason) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Send a Close message.
close() - Method in interface org.glassfish.tyrus.spi.TyrusClientSocket: Close the socket.
ComponentProvider - Class in org.glassfish.tyrus.spi: Provides an instance.
ComponentProvider() - Constructor for class org.glassfish.tyrus.spi.ComponentProvider
createServer(String, int) - Method in interface org.glassfish.tyrus.spi.TyrusContainer: Creates a new embedded HTTP server (if supported) listening to incoming connections at a given root path and port.
createSessionForRemoteEndpoint(SPIRemoteEndpoint, String, List<Extension>) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Creates a Session based on the SPIRemoteEndpoint, subprotocols and extensions.

D

destroyInstance(Object) - Method in class org.glassfish.tyrus.spi.ComponentProvider: Destroys the given managed instance.

G

getEndpointConfig() - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Get Endpoint configuration.
getEndpointPath() - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Get Endpoint absolute path.
getHeader(String) - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest: Get the Http Header value for the given header name in the underlying Http handshake request.
getNegotiatedExtensions(List<Extension>) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Get the negotiated extensions' names based on the extensions supported by client.
getNegotiatedProtocol(List<String>) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Compute the sub - protocol which will be used.
getOpenSessions() - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Get the endpoint's open Sessions.
getOpenSessions() - Method in interface org.glassfish.tyrus.spi.SPIRegisteredEndpoint: Get the endpoint's open Sessions.
getParameterMap() - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest: Return the request parameters associated with the request.
getQueryString() - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest: Get query string.
getRequestUri() - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest: Get the Http request uri underlying Http handshake request.
getSession() - Method in interface org.glassfish.tyrus.spi.TyrusClientSocket: Session representing the connection with server.
getUserPrincipal() - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest: Get user Principal.
getWebSocketContainer() - Method in class org.glassfish.tyrus.spi.SPIEndpoint

I

isApplicable(Class<?>) - Method in class org.glassfish.tyrus.spi.ComponentProvider: Checks whether this component provider is able to provide an instance of given Class.
isSecure() - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest: Get information about underlying connection.

O

onClose(SPIRemoteEndpoint, CloseReason) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection to the given remote endpoint has just closed.
onConnect(SPIRemoteEndpoint, String, List<Extension>) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection is established.
onError(Throwable) - Method in interface org.glassfish.tyrus.spi.SPIHandshakeListener: Called when an error is found in handshake response.
onMessage(SPIRemoteEndpoint, String) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection has an incoming text message from the given remote endpoint.
onMessage(SPIRemoteEndpoint, ByteBuffer) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection has an incoming binary message from the given remote endpoint.
onPartialMessage(SPIRemoteEndpoint, String, boolean) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection has an incoming partial text message from the given remote endpoint.
onPartialMessage(SPIRemoteEndpoint, ByteBuffer, boolean) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection has an incoming partial binary message from the given remote endpoint.
onPing(SPIRemoteEndpoint, ByteBuffer) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection has an incoming ping message from the given remote endpoint.
onPong(SPIRemoteEndpoint, ByteBuffer) - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider when the web socket connection has an incoming pong message from the given remote endpoint.
onResponseHeaders(Map<String, String>) - Method in interface org.glassfish.tyrus.spi.SPIHandshakeListener: Called when correct handshake response is received.
openClientSocket(String, ClientEndpointConfig, SPIEndpoint, SPIHandshakeListener, Map<String, Object>) - Method in interface org.glassfish.tyrus.spi.TyrusContainer: Open client socket - connect to endpoint specified with url parameter.
org.glassfish.tyrus.spi - package org.glassfish.tyrus.spi

P

provideInstance(Class<T>) - Method in class org.glassfish.tyrus.spi.ComponentProvider: Create new instance.

R

register(SPIEndpoint) - Method in interface org.glassfish.tyrus.spi.TyrusServer: The register method is called by the SDK when it has created a web socket endpoint it wishes to be managed.
remove() - Method in class org.glassfish.tyrus.spi.SPIEndpoint: Called by the provider after all connections have been closed to this endpoint, and after the endpoint has been removed from service.
remove() - Method in interface org.glassfish.tyrus.spi.SPIRegisteredEndpoint: Called by the SDK when it is cleaning up or needs to shut down.

S

sendBinary(ByteBuffer) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Send a binary message, returning when all of the message has been transmitted.
sendBinary(ByteBuffer, boolean) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Send a binary message in pieces, blocking until all of the message has been transmitted.
sendPing(ByteBuffer) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Send a Ping message containing the given application data to the remote endpoint.
sendPong(ByteBuffer) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Allows the developer to send an unsolicited Pong message containing the given application data in order to serve as a unidirectional heartbeat for the session.
sendText(String) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Send a text message, blocking until all of the message has been transmitted.
sendText(String, boolean) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Send a text message in pieces, blocking until all of the message has been transmitted.
setWriteTimeout(long) - Method in class org.glassfish.tyrus.spi.SPIRemoteEndpoint: Sets the timeout for the writing operation.
SPIEndpoint - Class in org.glassfish.tyrus.spi: The WebSocket SDK implements SPIEndpoint with its representation of a websocket endpoint mapped to a base URI that wishes to handle incoming messages.
SPIEndpoint() - Constructor for class org.glassfish.tyrus.spi.SPIEndpoint
SPIHandshakeListener - Interface in org.glassfish.tyrus.spi: Called when response is received from the server.
SPIHandshakeRequest - Interface in org.glassfish.tyrus.spi: The provider passes the handshake request to the SDK created endpoint
SPIRegisteredEndpoint - Interface in org.glassfish.tyrus.spi: The provider implements this interface in order to provide the web socket SDK a handle to the deployed endpoint that it may use later to un-register.
SPIRemoteEndpoint - Class in org.glassfish.tyrus.spi: Subset of RemoteEndpoint interface which should be implemented by container implementations.
SPIRemoteEndpoint() - Constructor for class org.glassfish.tyrus.spi.SPIRemoteEndpoint
start() - Method in interface org.glassfish.tyrus.spi.TyrusServer: Starts the server.
stop() - Method in interface org.glassfish.tyrus.spi.TyrusServer: Stops the server.

T

TyrusClientSocket - Interface in org.glassfish.tyrus.spi
TyrusContainer - Interface in org.glassfish.tyrus.spi: The TyrusContainer is the starting point of the provider SPI.
TyrusServer - Interface in org.glassfish.tyrus.spi: HTTP server abstraction.

U

unregister(SPIRegisteredEndpoint) - Method in interface org.glassfish.tyrus.spi.TyrusServer: The SDK calls unregister when it no longer wishes the endpoint to be in service.

C D G I O P R S T U