org.glassfish.tyrus.spi

Interface TyrusServer

public interface TyrusServer

HTTP server abstraction.

Author:

Martin Matula (martin.matula at oracle.com)

Method Summary

Methods

Modifier and Type	Method and Description
SPIRegisteredEndpoint	register(SPIEndpoint endpoint) The register method is called by the SDK when it has created a web socket endpoint it wishes to be managed.
void	start() Starts the server.
void	stop() Stops the server.
void	unregister(SPIRegisteredEndpoint ge) The SDK calls unregister when it no longer wishes the endpoint to be in service.

Method Detail

start

void start()
           throws IOException

Starts the server.

Throws:

IOException - if something goes wrong.

stop

void stop()

Stops the server.

register

SPIRegisteredEndpoint register(SPIEndpoint endpoint)
                               throws javax.websocket.DeploymentException

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

Parameters:

endpoint - SPIEndpoint to be registered.

Returns:

SPIRegisteredEndpoint.

Throws:

javax.websocket.DeploymentException - when endpoint cannot be registered.

unregister

void unregister(SPIRegisteredEndpoint ge)

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

Parameters:

ge - the endpoint which is going to be unregistered.