public final class EventingFactory extends Object
Modifier and Type | Method and Description |
---|---|
Object |
clone() |
static EventFilter |
createEventFilter()
Returns an
EventFilter object used by a consumer to limit the events that will be delivered. |
static EventingService |
createEventingService()
Returns an
EventingService object, which provides various Eventing Framework operations such as subscribing for events. |
static EventMetaData |
createEventMetaData()
Returns an
EventMetaData object used by a producer to provide data with an event publication that is typically used to match
against a subscription's EventFilter . |
static EventProducer |
createEventProducer(String family,
String type,
EventMetaData metaData,
String eventBody,
String eventVersion)
Returns an instance of an
EventProducer , which is used to publish an event. |
static EventSubscriptionAttributes |
createEventSubscriptionAttributes(String family)
Returns an
EventSubscriptionAttributes object that can be used to subscribe for an event. |
static EventSubscriptionAttributes |
createEventSubscriptionAttributes(String family,
List type)
Returns an
EventSubscriptionAttributes object that can be used to subscribe for an event. |
static EventSubscriptionAttributes |
createEventSubscriptionAttributes(String family,
String type)
Returns an
EventSubscriptionAttributes object that can be used to subscribe for an event. |
static SubscriptionSelectionFilter |
createSubscriptionSelectionFilter()
Returns a
SubscriptionSelectionFilter object used to set criteria for selecting a set of subscriptions. |
static boolean |
isEventingReady()
Returns true if the eventing framework is initialized and available for use; false, otherwise.
|
public static EventProducer createEventProducer(String family, String type, EventMetaData metaData, String eventBody, String eventVersion)
EventProducer
, which is used to publish an event.family
- Event familytype
- Event typemetaData
- EventMetaData
object which is used to provide data with an event that is useful to a consumer receiving the event.
The data that is present in this object can be specified by a consumer as a filter when subscribing for the event. The
filter ideally is used to limit event delivery to only those events that a consumer truly has interest in receiving.
Typically, data for an event that is not used for filtering should be placed in the event body. However, this is only a
general guideline. Data for which easy access is desired may also be a good candidate for inclusion in this object.eventBody
- Event body, which is an arbitrary set of data that is delivered to a consumer.eventVersion
- Event version which specifies the version of the schema defining the structure of the event body. The value is an
arbitrary string.public static EventSubscriptionAttributes createEventSubscriptionAttributes(String family)
EventSubscriptionAttributes
object that can be used to subscribe for an event. This form of the create method is
most useful for subscribing for all events in an event family (by specifying no event types in the the subscription attributes).family
- The event family.public static EventSubscriptionAttributes createEventSubscriptionAttributes(String family, String type)
EventSubscriptionAttributes
object that can be used to subscribe for an event. This form of the create method is
most useful for subscribing for a single event in an event family.family
- The event familytype
- The event typepublic static EventSubscriptionAttributes createEventSubscriptionAttributes(String family, List type)
EventSubscriptionAttributes
object that can be used to subscribe for an event. This form of the create method is
most useful for subscribing for multiple events in an event family.family
- The event familytype
- The event typepublic static EventFilter createEventFilter()
EventFilter
object used by a consumer to limit the events that will be delivered. This object is added to an
EventSubscriptionAttributes
object.public static SubscriptionSelectionFilter createSubscriptionSelectionFilter()
SubscriptionSelectionFilter
object used to set criteria for selecting a set of subscriptions. This object is passed
as a parameter to the querySubscriptions method of the EventingService
object.public static EventMetaData createEventMetaData()
EventMetaData
object used by a producer to provide data with an event publication that is typically used to match
against a subscription's EventFilter
.public static EventingService createEventingService()
EventingService
object, which provides various Eventing Framework operations such as subscribing for events.public static boolean isEventingReady()
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
Copyright © 2023 Avaya. All rights reserved.