org.glassfish.tyrus.spi

Interface SPIWebSocketProvider

public interface SPIWebSocketProvider

The SPIWebSocketProvider 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:

dannycoward

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	unregister(SPIRegisteredEndpoint ge) The SDK calls unregister when it no longer wishes the endpoint to be in service.

Method Detail

register

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.

Parameters:

endpoint - SPIEndpoint to be registered.

Returns:

SPIRegisteredEndpoint.

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.