org.glassfish.tyrus.spi

Interface ServerContainer

All Superinterfaces:

ServerContainer, WebSocketContainer

public interface ServerContainer
extends ServerContainer

HTTP server abstraction.

Author:

Martin Matula (martin.matula at oracle.com) TODO rename the class to avoid findbugs

Method Summary

Methods

Modifier and Type	Method and Description
WebSocketEngine	getWebSocketEngine() Returns WebSocketEngine to upgrade requests and setting up the connection
void	start(String rootPath, int port) Starts the server.
void	stop() Stops the server.

Methods inherited from interface javax.websocket.server.ServerContainer

addEndpoint, addEndpoint

Methods inherited from interface javax.websocket.WebSocketContainer

connectToServer, connectToServer, connectToServer, connectToServer, getDefaultAsyncSendTimeout, getDefaultMaxBinaryMessageBufferSize, getDefaultMaxSessionIdleTimeout, getDefaultMaxTextMessageBufferSize, getInstalledExtensions, setAsyncSendTimeout, setDefaultMaxBinaryMessageBufferSize, setDefaultMaxSessionIdleTimeout, setDefaultMaxTextMessageBufferSize

Method Detail

start

void start(String rootPath,
         int port)
           throws IOException,
                  DeploymentException

Starts the server. 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

Throws:

IOException - if something goes wrong.

DeploymentException

stop

void stop()

Stops the server.

getWebSocketEngine

WebSocketEngine getWebSocketEngine()

Returns WebSocketEngine to upgrade requests and setting up the connection

Returns:

websocket engine