Package org.openremote.model.event.shared

Class EventSubscription<E extends Event>

java.lang.Object

org.openremote.model.event.shared.EventSubscription<E>

public class EventSubscription<E extends Event>
extends Object

A consumer can subscribe to Events on the server, providing the type of event it wants to receive as well as filter criteria to restrict the events to an interesting subset.

A subscription can optionally contain a subscriptionId which allows a client to have multiple subscriptions for the same event type.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	eventType
protected EventFilter<E>	filter
static final String	SUBSCRIBE_MESSAGE_PREFIX
protected boolean	subscribed
static final String	SUBSCRIBED_MESSAGE_PREFIX
protected String	subscriptionId

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventSubscription()
	EventSubscription(Class<E> eventClass)
	EventSubscription(Class<E> eventClass, EventFilter<E> filter)
	EventSubscription(Class<E> eventClass, EventFilter<E> filter, String subscriptionId)
	EventSubscription(String eventType)
	EventSubscription(String eventType, EventFilter<E> filter)

Method Summary

Modifier and Type	Method	Description
String	getEventType()
EventFilter<E>	getFilter()
String	getSubscriptionId()
boolean	isEventType(Class<? extends Event> eventClass)
boolean	isSubscribed()
void	setFilter(EventFilter<E> filter)
void	setSubscribed(boolean subscribed)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SUBSCRIBE_MESSAGE_PREFIX

public static final String SUBSCRIBE_MESSAGE_PREFIX

See Also:

• Constant Field Values

SUBSCRIBED_MESSAGE_PREFIX

public static final String SUBSCRIBED_MESSAGE_PREFIX

See Also:

• Constant Field Values

eventType

protected String eventType

filter

protected EventFilter<E extends Event> filter

subscriptionId

protected String subscriptionId

subscribed

protected boolean subscribed

Constructor Details

EventSubscription

protected EventSubscription()

EventSubscription

public EventSubscription(String eventType)

EventSubscription

public EventSubscription(Class<E> eventClass)

EventSubscription

public EventSubscription(String eventType,
 EventFilter<E> filter)

EventSubscription

public EventSubscription(Class<E> eventClass,
 EventFilter<E> filter)

EventSubscription

public EventSubscription(Class<E> eventClass,
 EventFilter<E> filter,
 String subscriptionId)

Method Details

getEventType

public String getEventType()

getFilter

public EventFilter<E> getFilter()

setFilter

public void setFilter(EventFilter<E> filter)

isEventType

public boolean isEventType(Class<? extends Event> eventClass)

getSubscriptionId

public String getSubscriptionId()

setSubscribed

public void setSubscribed(boolean subscribed)

isSubscribed

public boolean isSubscribed()

toString

public String toString()

Overrides:

toString in class Object