public interface EventMetaData
Modifier and Type | Method and Description |
---|---|
EventMetaData |
addValue(String key,
String value)
(Optional) - Add arbitrary key/value pairs as meta data.
|
String |
getCorrelationId()
Get the correlation ID associated with an event.
|
String |
getProducerName()
Get the producer name.
|
String |
getProducerVersion()
Get the producer version.
|
String |
getUser()
Get the user associated with an event.
|
Map |
getValueMap()
Returns a reference to the internal map holding meta data key, value
pairs.
|
EventMetaData |
setCorrelationId(String correlationId)
(Optional) - Set a correlation ID associated with an event.
|
EventMetaData |
setProducerName(String name)
(Optional) - Set the producer name.
|
EventMetaData |
setProducerVersion(String version)
(Optional) - Set the producer version.
|
EventMetaData |
setUser(String user)
(Optional) - Set a user associated with an event.
|
EventMetaData setUser(String user)
user
- The user associated with this event.EventMetaData setCorrelationId(String correlationId)
correlationId
- The correlation ID associated with this event. The typical use
for this data is the following. Assume a consumer makes a
request from a producer for some resource that typically
cannot be provided immediately. When the resource is
available, the producer will publish an event to indicate that
availability. The correlation ID is a value generated during
the initial request and shared between the producer and the
consumer so that the later event can be correlated with the
initial request.EventMetaData addValue(String key, String value)
key
- The key for the meta data.value
- The value for the meta data.EventMetaData setProducerName(String name)
name
- The producer name.EventMetaData setProducerVersion(String version)
version
- The producer version. The value is an arbitrary string.String getUser()
String getCorrelationId()
Map getValueMap()
String getProducerName()
String getProducerVersion()
Copyright © 2016 Avaya. All Rights Reserved.