Package org.openhab.core.io.websocket.event

Class EventWebSocketAdapter

java.lang.Object

org.openhab.core.io.websocket.event.EventWebSocketAdapter

All Implemented Interfaces:

EventSubscriber, WebSocketAdapter

@NonNullByDefault
public class EventWebSocketAdapter
extends Object
implements EventSubscriber, WebSocketAdapter

The EventWebSocketAdapter allows subscription to oh events over WebSocket

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADAPTER_ID

Fields inherited from interface org.openhab.core.events.EventSubscriber

ALL_EVENT_TYPES

Constructor Summary

Constructors

Constructor	Description
EventWebSocketAdapter(EventPublisher eventPublisher, ItemRegistry itemRegistry)

Method Summary

Modifier and Type	Method	Description
Object	createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest servletUpgradeRequest, org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse servletUpgradeResponse)	Creates a websocket instance.
String	getId()	The adapter id.
Set<String>	getSubscribedEventTypes()	Gets the event types to which the event subscriber is subscribed to.
void	receive(Event event)	Callback method for receiving Events from the openHAB event bus.
void	registerListener(EventWebSocket eventWebSocket)
void	unregisterListener(EventWebSocket eventWebSocket)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.events.EventSubscriber

getEventFilter

Field Details

ADAPTER_ID

public static final String ADAPTER_ID

See Also:

• Constant Field Values

Constructor Details

EventWebSocketAdapter

public EventWebSocketAdapter(EventPublisher eventPublisher,
 ItemRegistry itemRegistry)

Method Details

getSubscribedEventTypes

public Set<String> getSubscribedEventTypes()

Description copied from interface: EventSubscriber

Gets the event types to which the event subscriber is subscribed to.

Specified by:

getSubscribedEventTypes in interface EventSubscriber

Returns:

subscribed event types (not null)

receive

public void receive(Event event)

Description copied from interface: EventSubscriber

Callback method for receiving Events from the openHAB event bus. This method is called for every event where the event subscriber is subscribed to and the event filter applies.

Specified by:

receive in interface EventSubscriber

Parameters:

event - the received event (not null)

registerListener

public void registerListener(EventWebSocket eventWebSocket)

unregisterListener

public void unregisterListener(EventWebSocket eventWebSocket)

getId

public String getId()

Description copied from interface: WebSocketAdapter

The adapter id. In combination with the base path CommonWebSocketServlet.SERVLET_PATH defines the adapter path.

Specified by:

getId in interface WebSocketAdapter

Returns:

the adapter id.

createWebSocket

public Object createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest servletUpgradeRequest,
 org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse servletUpgradeResponse)

Description copied from interface: WebSocketAdapter

Creates a websocket instance. It should use the org.eclipse.jetty.websocket.api.annotations or implement WebSocketListener.

Specified by:

createWebSocket in interface WebSocketAdapter

Returns:

a websocket instance.