eu.hgross.blaubot.websocket

Class BlaubotWebsocketAdapter

java.lang.Object

eu.hgross.blaubot.websocket.BlaubotWebsocketAdapter

All Implemented Interfaces:

IBlaubotAdapter

public class BlaubotWebsocketAdapter
extends java.lang.Object
implements IBlaubotAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_WEBSOCKET_FRAME_SIZE The max allowable websocket frame size.
static java.lang.String	URI_PARAM_UNIQUEDEVICEID The request parameter name for the unique device id when connecting to WEBSOCKET_PATH
static java.lang.String	WEBSOCKET_PATH The path for the web socket handshake

Constructor Summary

Constructors

Constructor and Description
BlaubotWebsocketAdapter(IBlaubotDevice ownDevice, java.lang.String hostAddress, int acceptorPort)

Method Summary

Modifier and Type	Method and Description
Blaubot	getBlaubot() Get the current blaubot instance
BlaubotAdapterConfig	getBlaubotAdapterConfig() Configuration object for hardware specific adapter settings.
IBlaubotConnectionAcceptor	getConnectionAcceptor() Get the connection acceptor that is in charge to retrieve incoming connections issued by compatible IBlaubotConnector implementations.
ConnectionStateMachineConfig	getConnectionStateMachineConfig() The adapter specific ConnectionStateMachine configuration.
IBlaubotConnector	getConnector() Get the connector for this adapter.
static void	main(java.lang.String[] args)
void	setBlaubot(Blaubot blaubotInstance) Setter for dependency injection of the blaubot instance.

Methods inherited from class java.lang.Object

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

Field Detail

WEBSOCKET_PATH

public static final java.lang.String WEBSOCKET_PATH

The path for the web socket handshake

See Also:

Constant Field Values

MAX_WEBSOCKET_FRAME_SIZE

public static final int MAX_WEBSOCKET_FRAME_SIZE

The max allowable websocket frame size. Above this limits, connections will be disconnected. Note: This limit exists because it is a big gate for DoS attacks and is usually much lower by default, then used by blaubot.

See Also:

Constant Field Values

URI_PARAM_UNIQUEDEVICEID

public static final java.lang.String URI_PARAM_UNIQUEDEVICEID

The request parameter name for the unique device id when connecting to WEBSOCKET_PATH

See Also:

Constant Field Values

Constructor Detail

BlaubotWebsocketAdapter

public BlaubotWebsocketAdapter(IBlaubotDevice ownDevice,
                               java.lang.String hostAddress,
                               int acceptorPort)

Parameters:

ownDevice - our own device

hostAddress - the own host address (interfaces to bind to)

acceptorPort - the acceptor port to use (to open the websocket server on)

Method Detail

getConnector

public IBlaubotConnector getConnector()

Description copied from interface: IBlaubotAdapter

Get the connector for this adapter. The connector is the counterpart of this adapter's acceptor and allows to make connections to the corresponding acceptor.

Specified by:

getConnector in interface IBlaubotAdapter

Returns:

the connector

getConnectionAcceptor

public IBlaubotConnectionAcceptor getConnectionAcceptor()

Description copied from interface: IBlaubotAdapter

Get the connection acceptor that is in charge to retrieve incoming connections issued by compatible IBlaubotConnector implementations.

Specified by:

getConnectionAcceptor in interface IBlaubotAdapter

Returns:

the acceptor

setBlaubot

public void setBlaubot(Blaubot blaubotInstance)

Description copied from interface: IBlaubotAdapter

Setter for dependency injection of the blaubot instance.

Specified by:

setBlaubot in interface IBlaubotAdapter

Parameters:

blaubotInstance - the blaubot instance

getBlaubot

public Blaubot getBlaubot()

Description copied from interface: IBlaubotAdapter

Get the current blaubot instance

Specified by:

getBlaubot in interface IBlaubotAdapter

Returns:

the blaubot instance

getConnectionStateMachineConfig

public ConnectionStateMachineConfig getConnectionStateMachineConfig()

Description copied from interface: IBlaubotAdapter

The adapter specific ConnectionStateMachine configuration.

Specified by:

getConnectionStateMachineConfig in interface IBlaubotAdapter

Returns:

the connection state machine configuration specific for this adapter.

getBlaubotAdapterConfig

public BlaubotAdapterConfig getBlaubotAdapterConfig()

Description copied from interface: IBlaubotAdapter

Configuration object for hardware specific adapter settings.

Specified by:

getBlaubotAdapterConfig in interface IBlaubotAdapter

Returns:

the config for this adapter

main

public static void main(java.lang.String[] args)