C G I O R S U

C

checkHandshake(SPIHandshakeRequest) - Method in interface org.glassfish.tyrus.spi.SPIEndpoint

This method must be called by the provider during its check for a successful websocket handshake.

close(int, String) - Method in interface org.glassfish.tyrus.spi.SPIRemoteEndpoint

Close the underlying connection using the web socket defined codes.

G

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.

getRequestURI() - Method in interface org.glassfish.tyrus.spi.SPIHandshakeRequest

Get the Http request uri underlying Http handshake request.

getSupportedProtocols(List<String>) - Method in interface org.glassfish.tyrus.spi.SPIEndpoint

Called by the provider during the handshake to determine a list of subprotocols this endpoint will support of those passed in.

getUri() - Method in interface org.glassfish.tyrus.spi.SPIRemoteEndpoint

Returns the URI http request as a String.

I

isConnected() - Method in interface org.glassfish.tyrus.spi.SPIRemoteEndpoint

Return true iff the connection is active.

O

onClose(SPIRemoteEndpoint) - Method in interface org.glassfish.tyrus.spi.SPIEndpoint

Called by the provider when the web socket connection to the given remote endpoint has just closed.

onConnect(SPIRemoteEndpoint) - Method in interface org.glassfish.tyrus.spi.SPIEndpoint

Called by the provider when the web socket connection is established.

onMessage(SPIRemoteEndpoint, String) - Method in interface 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, byte[]) - Method in interface org.glassfish.tyrus.spi.SPIEndpoint

Called by the provider when the web socket connection has an incoming binary message from the given remote endpoint.

org.glassfish.tyrus.spi - package org.glassfish.tyrus.spi

R

register(SPIEndpoint) - Method in interface org.glassfish.tyrus.spi.SPIWebSocketProvider

The register method is called by the SDK when it has created a web socket endpoint it wishes to be managed.

remove() - Method in interface 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

S

send(String) - Method in interface org.glassfish.tyrus.spi.SPIRemoteEndpoint

Send the given string, throwing the IOException if the message is not sent.

send(byte[]) - Method in interface org.glassfish.tyrus.spi.SPIRemoteEndpoint

Send the given data, throwing the IOException if the message is not sent.

SPIEndpoint - Interface 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.

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 unregister.

SPIRemoteEndpoint - Interface in org.glassfish.tyrus.spi

This interface represents the unique object which represents the other end of the web socket connection (i.e.

SPIWebSocketProvider - Interface in org.glassfish.tyrus.spi

The SPIWebSocketProvider is the starting point of the provider SPI.

U

unregister(SPIRegisteredEndpoint) - Method in interface org.glassfish.tyrus.spi.SPIWebSocketProvider

The SDK calls unregister when it no longer wishes the endpoint to be in service.

C G I O R S U