Package de.iip_ecosphere.platform.support.websocket

Class WebsocketFactory

java.lang.Object

de.iip_ecosphere.platform.support.websocket.WebsocketFactory

public abstract class WebsocketFactory
extends Object

Generic access to WebSockets. Requires an implementing plugin of type WebsocketFactory or an active WebsocketFactoryProviderDescriptor. Simplified interface akin to WebSocket.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebsocketFactory.StatusListener	Is called on status changes.
static interface	WebsocketFactory.WebSocket	A web socket.

Field Summary

Fields

Modifier and Type	Field	Description
private static WebsocketFactory	instance

Constructor Summary

Constructors

Constructor	Description
WebsocketFactory()

Method Summary

Modifier and Type	Method	Description
abstract de.iip_ecosphere.platform.support.Server	createBroadcastingServer(de.iip_ecosphere.platform.support.ServerAddress address)	Creates a broadcasting/relay server.
abstract WebsocketFactory.WebSocket	createSocket(URI uri)	Creates the websocket.
static WebsocketFactory	getInstance()	Returns the WebServices instance.
static void	setInstance(WebsocketFactory rest)	Manually sets the instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

instance

private static WebsocketFactory instance

Constructor Details

WebsocketFactory

public WebsocketFactory()

Method Details

getInstance

public static WebsocketFactory getInstance()

Returns the WebServices instance.

Returns:

the instance

setInstance

public static void setInstance(WebsocketFactory rest)

Manually sets the instance. Shall not be needed, but may be required in some tests.

Parameters:

rest - the Rest instance

createSocket

public abstract WebsocketFactory.WebSocket createSocket(URI uri)
                                                 throws IOException

Creates the websocket.

Parameters:

uri - the URI to connect to

Returns:

the socket instance

Throws:

IOException - if creating fails

createBroadcastingServer

public abstract de.iip_ecosphere.platform.support.Server createBroadcastingServer(de.iip_ecosphere.platform.support.ServerAddress address)
                                                                           throws IOException

Creates a broadcasting/relay server.

Parameters:

address - the server address

Returns:

the socket instance

Throws:

IOException - if creating fails