public interface EventSubscriptionAttributes
Modifier and Type | Method and Description |
---|---|
EventSubscriptionAttributes |
addEventType(String eventType)
(Optional) - Add an event type to the subscription attributes.
|
EventSubscriptionAttributes |
clearDeliverToPreferredVersion()
(Optional) - Clear the "deliver to preferred version" option.
|
EventSubscriptionAttributes |
clearMatchConsumerToUserViaServiceProfile()
(Optional) - Clear the "match consumer to user via service profile"
option.
|
EventSubscriptionAttributes |
clearPopulateConsumerPreferredVersion()
(Optional) - Clear the "populate preferred consumer version" option.
|
String |
getConsumerName()
Get the consumer name associated with the subscription.
|
Serializable |
getConsumerPrivateData()
Get the consumer private data associated with the subscription.
|
String |
getConsumerVersion()
Get the consumer version associated with the subscription.
|
List |
getEventTypeList()
Get a reference to the internal list that holds events types.
|
String |
getFamily()
Get the event family associated with the subscription.
|
EventFilter |
getFilter()
Get the event filter associated with the subscription.
|
boolean |
isDeliverToPreferredVersion() |
boolean |
isMatchConsumerToUserViaServiceProfile() |
boolean |
isPopulateConsumerPreferredVersion() |
EventSubscriptionAttributes |
setConsumerName(String name)
(Optional) - Set the consumer name associated with this subscription.
|
EventSubscriptionAttributes |
setConsumerPrivateData(Serializable consumerPrivateData)
(Optional) - Set an arbitrary object/set of data associated with this
subscription.
|
EventSubscriptionAttributes |
setConsumerVersion(String version)
(Optional) - Set the consumer version associated with this subscription.
|
EventSubscriptionAttributes |
setDeliverToPreferredVersion()
(Optional) - Set the "deliver to preferred version" option when
subscribing.
|
EventSubscriptionAttributes |
setFilter(EventFilter filter)
(Optional) - Set an EventFilter object for this subscription.
|
EventSubscriptionAttributes |
setMatchConsumerToUserViaServiceProfile()
(Optional) - Set the "match consumer to user via service profile" option
when subscribing.
|
EventSubscriptionAttributes |
setPopulateConsumerPreferredVersion()
(Optional) - Set the "populate preferred consumer version" option when
subscribing.
|
EventSubscriptionAttributes addEventType(String eventType)
eventType
- The eventType type to add to the subscription attributes. Each
call to this method adds an eventType to the list of event
types for which the consumer wishes to receive events.List getEventTypeList()
EventSubscriptionAttributes setConsumerPrivateData(Serializable consumerPrivateData)
consumerPrivateData
- The arbitrary object/set of day to be associated with this
subscription.EventSubscriptionAttributes setFilter(EventFilter filter)
filter
- The EventFilter object that specifies filtering criteria to
limit the events received by the consumer.EventSubscriptionAttributes setConsumerName(String name)
name
- The name of the consumer associated with this subscription. This method allows a consumer to subscribe on behalf of another consumer and then receive this information back with a delivered event so that the subscribing consumer will know which other consumer it subscribed "on behalf of".
Setting this value has no effect on which consumer will receive the delivery of an event. The actual subscribing consumer is used for delivery.EventSubscriptionAttributes setConsumerVersion(String version)
version
- The version of the consumer associated with this subscription. This method allows a consumer to subscribe on behalf of another consumer and then receive this information back with a delivered event so that the subscribing consumer will know which other consumer it subscribed "on behalf of".
Setting this value has no effect on which version of a consumer will receive the delivery of an event. The actual version of the subscribing consumer is used for delivery unless modified by the "deliver to preferred version" option.EventSubscriptionAttributes setDeliverToPreferredVersion()
EventSubscriptionAttributes clearDeliverToPreferredVersion()
EventSubscriptionAttributes setPopulateConsumerPreferredVersion()
(Optional) - Set the "populate preferred consumer version" option when subscribing. This option will result in the preferred version of the consumer being populated in the consumer version field of a delivered event. The version populated will be for the consumer name set by the method setConsumerName.
Effective use of this option first depends on an understanding of the
material described in the following two sections of the package-level
Javadoc for
com.avaya.collaboration.eventing
:
EventSubscriptionAttributes clearPopulateConsumerPreferredVersion()
EventSubscriptionAttributes setMatchConsumerToUserViaServiceProfile()
(Optional) - Set the "match consumer to user via service profile" option
when subscribing. This option provides a dynamic way of filtering
subscriptions based on the association between a consumer (either the
actual or "on behalf of" consumer, as detailed later) and a user
configured in the Avaya Aura® System Manager; this association is
determined at the point when an event is published. This option, then,
provides a way to filter based on user and service profile where the
consumer does not need to explicitly set the user and/or service profile
in an EventFilter
.
A consumer "matches" a user if a published event includes a user in metadata and the user's service profile includes the consumer in its list of services. If no match occurs, the event is excluded from delivery. This approach allows the association to be controlled in Avaya Aura® System Manager. The identity of the user must be either the SIP or E.164 communication address configured for the user.
Note that filtering specified in the EventFilter
is also applied
against published events; such filtering is combined with the filtering
aspects of this option using "AND". Typically user and service profile
should not be specified in the EventFilter
when this option is
used.
The behavior of this option varies depending on whether or not a consumer
name has been specified using the setConsumerName method. If a
consumer name has been specified, then this options causes a subscription
to operate in an "on behalf of" manner. The specified consumer name is
used for the matching described earlier. In the event of a match, the
consumer version (retrievable from a delivered event through the
getConsumerVersion method of the Event
class) will be
set to the version of the consumer that has been configured in the
service profile; any version set explicitly with the
setConsumerVersion method of this class is ignored.
EventSubscriptionAttributes clearMatchConsumerToUserViaServiceProfile()
String getFamily()
Serializable getConsumerPrivateData()
EventFilter getFilter()
String getConsumerName()
String getConsumerVersion()
boolean isDeliverToPreferredVersion()
boolean isPopulateConsumerPreferredVersion()
boolean isMatchConsumerToUserViaServiceProfile()
Copyright © 2023 Avaya. All rights reserved.