Package org.openhab.core.events

Interface EventSubscriber

All Known Implementing Classes:

AbstractItemEventSubscriber, AbstractTypedEventSubscriber, EventWebSocketAdapter, SitemapSubscriptionService

@NonNullByDefault
public interface EventSubscriber

The EventSubscriber defines the callback interface for receiving events from the openHAB event bus.

Author:

Stefan Bußweiler - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_EVENT_TYPES	The constant ALL_EVENT_TYPES must be returned by the getSubscribedEventTypes() method, if the event subscriber should subscribe to all event types.

Method Summary

Modifier and Type	Method	Description
default @Nullable EventFilter	getEventFilter()	Gets an EventFilter in order to receive specific events if the filter applies.
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.

Field Details

ALL_EVENT_TYPES

static final String ALL_EVENT_TYPES

The constant ALL_EVENT_TYPES must be returned by the getSubscribedEventTypes() method, if the event subscriber should subscribe to all event types.

See Also:

• Constant Field Values

Method Details

getSubscribedEventTypes

Set<String> getSubscribedEventTypes()

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

Returns:

subscribed event types (not null)

getEventFilter

default @Nullable EventFilter getEventFilter()

Gets an EventFilter in order to receive specific events if the filter applies. If there is no filter all subscribed event types are received.

Returns:

the event filter, or null

receive

void receive(Event event)

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.

Parameters:

event - the received event (not null)