org.glassfish.tyrus.spi
Interface TyrusContainer

All Known Implementing Classes:

GrizzlyBasedEngine, GrizzlyEngine

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

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 path, ClientEndpointConfiguration cec, SPIEndpoint endpoint)

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 path,
                                   ClientEndpointConfiguration cec,
                                   SPIEndpoint endpoint)