Package org.openhab.core.io.websocket

Class EventWebSocketServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.eclipse.jetty.websocket.servlet.WebSocketServlet

org.openhab.core.io.websocket.EventWebSocketServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, EventSubscriber

@NonNullByDefault
public class EventWebSocketServlet
extends org.eclipse.jetty.websocket.servlet.WebSocketServlet
implements EventSubscriber

The EventWebSocketServlet provides the servlet for WebSocket connections

Author:

Jan N. Klug - Initial contribution

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVLET_PATH

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

ALL_EVENT_TYPES

Constructor Summary

Constructors

Constructor	Description
EventWebSocketServlet(UserRegistry userRegistry, EventPublisher eventPublisher, ItemRegistry itemRegistry)

Method Summary

Modifier and Type	Method	Description
void	configure(org.eclipse.jetty.websocket.servlet.WebSocketServletFactory webSocketServletFactory)
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 org.eclipse.jetty.websocket.servlet.WebSocketServlet

destroy, init, service

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

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

SERVLET_PATH

public static final String SERVLET_PATH

See Also:

• Constant Field Values

Constructor Details

EventWebSocketServlet

public EventWebSocketServlet(UserRegistry userRegistry,
 EventPublisher eventPublisher,
 ItemRegistry itemRegistry)
                      throws javax.servlet.ServletException,
org.osgi.service.http.NamespaceException

Throws:

javax.servlet.ServletException

org.osgi.service.http.NamespaceException

Method Details

configure

public void configure(@NonNullByDefault({})
 org.eclipse.jetty.websocket.servlet.WebSocketServletFactory webSocketServletFactory)

Specified by:

configure in class org.eclipse.jetty.websocket.servlet.WebSocketServlet

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)