org.glassfish.tyrus.spi

Interface TyrusContainer

public interface TyrusContainer

The TyrusContainer is the starting point of the provider SPI. The provider must implement this class with a public no args constructor. The new provider can be configured in the web.xml of the web application requesting the new provider by specifying a servlet context initialization parameter of key org.glassfish.websocket.provider.class and value the fully qualified classname of the provider class.

Author:

Danny Coward (danny.coward at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
TyrusServer	createServer(String rootPath, int port) Creates a new embedded HTTP server (if supported) listening to incoming connections at a given root path and port.
TyrusClientSocket	openClientSocket(String url, javax.websocket.ClientEndpointConfig cec, SPIEndpoint endpoint, SPIHandshakeListener handshakeListener, Map<String,Object> properties) Open client socket - connect to endpoint specified with url parameter.

Method Detail

createServer

TyrusServer createServer(String rootPath,
                       int port)

Creates a new embedded HTTP server (if supported) listening to incoming connections at a given root path and port.

Parameters:

rootPath - context root

port - TCP port

Returns:

server that can be started and stopped

openClientSocket

TyrusClientSocket openClientSocket(String url,
                                 javax.websocket.ClientEndpointConfig cec,
                                 SPIEndpoint endpoint,
                                 SPIHandshakeListener handshakeListener,
                                 Map<String,Object> properties)
                                   throws javax.websocket.DeploymentException

Open client socket - connect to endpoint specified with url parameter.

Parameters:

url - address where remote service is deployed.

cec - endpoint configuration.

endpoint - endpoint instance.

handshakeListener - handshake listener.

properties - properties map.

Returns:

representation of incoming socket.

Throws:

javax.websocket.DeploymentException