com.hcl.voltmx.middleware.api.events

Class EventData

java.lang.Object

com.hcl.voltmx.middleware.api.events.EventData

public class EventData
extends Object

EventData class is used to create events with details. These events can be notified to different subscriber depending on the event name or also know as topic. The event name or topic is hierarchical in nature which means it could have child topics as well. Child topics will receive all notifications of parent topic. / is used as separator in topic name. For example, parent topic can be "transaction" and it can have children topics "transaction/credit" and "transaction/debit". Both these child topics will receive all the notifications which are raised on the parent "transaction" topic. However, event raised on child topic "transaction/credit" will be received only by that child.

Since:

Foundry V8 SP4 FP2 (8.4.2) release

See Also:

EventNotifier, EventManager, EventStatus, EventSubscriber

Constructor Summary

Constructors

Constructor and Description
EventData(String eventNameOrTopic, Object data) Creates an event data.
EventData(String eventNameOrTopic, Object data, ServicesManager servicesManager) Creates an event data.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalMetadata(String key, Object value) Adds additional metadata of the event.
void	addStatusObserver(BiConsumer<EventStatus,EventData> observer) Adds the observer for the status change event.
boolean	canNotify() Checks whether it is time for the event to be notified or not.
boolean	equals(Object obj)
static List<EventData>	fromJson(String jsonString) Generates a list of events from given JSON string representation.
Map<String,Object>	getAdditionalMetadata() Gets the collection of all additional metadata of the event.
Object	getAdditionalMetadata(String metadataName) Gets the additional metadata with specified name.
String	getAppId() Gets the Foundry application id.
String	getAppName() Gets the Foundry application name.
Object	getData() Gets the data of the event.
int	getDelayNotificationInMilliseconds() Gets the time in milliseconds to delay the notification of the event.
String	getId() Gets the unique id of the event.
EventMonitoringData	getMonitoringData() Gets the monitoring data of the event.
String	getProducer() Gets the producer of the event.
ServicesManager	getServicesManager() Gets the ServicesManager associated with the event.
EventStatus	getStatus() Gets the current status of the event.
long	getTimestamp() Gets the timestamp of the event in milliseconds.
String	getTopic() Gets the name or topic of the event.
String	getType() Gets the type of the event.
UserProfile	getUserProfile() Gets the UserProfile which contain information like user id, first name, last name and email id.
int	hashCode()
void	notify(EventSubscriber eventSubscriber, int retryCount) Notifies the subscriber of this event.
void	removeAllStatusObservers() Removes all the observers for the status change event.
void	setDelayNotificationInMilliseconds(int delayNotificationInMilliseconds) Sets the time in milliseconds to delay the notification of the event.
void	setProducer(String producer) Sets the producer of the event.
void	setStatus(EventStatus status) Sets the status of the event.
void	setType(String type) Sets the type of the event.
String	toJson() Returns JSON string representation of the event.
String	toString()
boolean	waitForProcessing(long processingWaitTimeInMilliseconds) Waits for processing of the event to be completed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EventData

public EventData(String eventNameOrTopic,
                 Object data)

Creates an event data.

Parameters:

eventNameOrTopic - The name or topic of the event.

data - The data of the event.

See Also:

EventData(String, Object, ServicesManager)

EventData

public EventData(String eventNameOrTopic,
                 Object data,
                 ServicesManager servicesManager)

Creates an event data.

Parameters:

eventNameOrTopic - The name or topic of the event.

data - The data of the event.

servicesManager - The ServicesManager. This is needed to add Identity attributes like UserProfile to the event.

See Also:

EventData(String, Object), getAppId(), getAppName(), getUserProfile()

Method Detail

getId

public String getId()

Gets the unique id of the event.

Returns:

The unique id.

getTimestamp

public long getTimestamp()

Gets the timestamp of the event in milliseconds. Multiple events may have same timestamp.

Returns:

The timestamp of the event.

See Also:

System.currentTimeMillis()

getTopic

public String getTopic()

Gets the name or topic of the event.

Returns:

The name or topic of the event.

getData

public Object getData()

Gets the data of the event.

Returns:

The data of the event.

getAppId

public String getAppId()

Gets the Foundry application id. This is available only when EventData(String, Object, ServicesManager) is used to create event.

Returns:

The Foundry application id.

getAppName

public String getAppName()

Gets the Foundry application name. This is available only when EventData(String, Object, ServicesManager) is used to create event.

Returns:

The Foundry application name.

Since:

Foundry V9 (9.0) release

getUserProfile

public UserProfile getUserProfile()

Gets the UserProfile which contain information like user id, first name, last name and email id. This is available only when EventData(String, Object, ServicesManager) is used to create event.

Returns:

The UserProfile.

getType

public String getType()

Gets the type of the event.

Returns:

The type of the event.

setType

public void setType(String type)

Sets the type of the event.

Parameters:

type - The type of the event.

getAdditionalMetadata

public Map<String,Object> getAdditionalMetadata()

Gets the collection of all additional metadata of the event.

Returns:

Collection of all additional metadata of the event.

getAdditionalMetadata

public Object getAdditionalMetadata(String metadataName)

Gets the additional metadata with specified name.

Parameters:

metadataName - The name of the metadata.

Returns:

The additional metadata with specified name.

Since:

Foundry V9 (9.0) release

addAdditionalMetadata

public void addAdditionalMetadata(String key,
                                  Object value)

Adds additional metadata of the event.

Parameters:

key - The key of additional metadata of the event.

value - The value of additional metadata of the event.

getProducer

public String getProducer()

Gets the producer of the event.

Returns:

The producer of the event.

setProducer

public void setProducer(String producer)

Sets the producer of the event.

Parameters:

producer - The producer of the event.

getServicesManager

public ServicesManager getServicesManager()

Gets the ServicesManager associated with the event. If ServicesManager passed to the event is null then it will return either default or null value.

Returns:

The ServicesManager.

Since:

Foundry V9 (9.0) release

getDelayNotificationInMilliseconds

public int getDelayNotificationInMilliseconds()

Gets the time in milliseconds to delay the notification of the event.

Returns:

The time in milliseconds to delay the notification of the event.

Since:

Foundry V9 (9.0) release

setDelayNotificationInMilliseconds

public void setDelayNotificationInMilliseconds(int delayNotificationInMilliseconds)

Sets the time in milliseconds to delay the notification of the event.

Parameters:

delayNotificationInMilliseconds - The time in milliseconds to delay the notification of the event.

Since:

Foundry V9 (9.0) release

getStatus

public EventStatus getStatus()

Gets the current status of the event.

Returns:

The EventStatus.

setStatus

public void setStatus(EventStatus status)

Sets the status of the event.

FOR INTERNAL USE ONLY

Parameters:

status - The EventStatus.

addStatusObserver

public void addStatusObserver(BiConsumer<EventStatus,EventData> observer)

Adds the observer for the status change event.

Parameters:

observer - The observer to add for the status change.

Since:

Foundry V9 (9.0) release

removeAllStatusObservers

public void removeAllStatusObservers()

Removes all the observers for the status change event.

Since:

Foundry V9 (9.0) release

getMonitoringData

public EventMonitoringData getMonitoringData()

Gets the monitoring data of the event.

FOR INTERNAL USE ONLY

Since:

Foundry V9 (9.0) release

canNotify

public boolean canNotify()

Checks whether it is time for the event to be notified or not.

Returns:

True if it is time for the event to be notified, false otherwise.

Since:

Foundry V9 (9.0) release

waitForProcessing

public boolean waitForProcessing(long processingWaitTimeInMilliseconds)

Waits for processing of the event to be completed.

Parameters:

processingWaitTimeInMilliseconds - The time in milliseconds to wait for processing to complete.

Returns:

True if processing was complete, false otherwise.

Throws:

IllegalStateException - if the event was never queued.

Since:

Foundry V9 (9.0) release

notify

public void notify(EventSubscriber eventSubscriber,
                   int retryCount)

Notifies the subscriber of this event.

FOR INTERNAL USE ONLY

Parameters:

eventSubscriber - The subscriber

retryCount - The retry count

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

Returns JSON string representation of the event.

Returns:

JSON string

Since:

Foundry V8 SP4 FP3 (8.4.3) release

fromJson

public static List<EventData> fromJson(String jsonString)

Generates a list of events from given JSON string representation.

Parameters:

jsonString - The JSON string. For example:

          "{\"events\":[{\"topic\":\"topic1\",\"data\":\"data1\",\"type\":\"type1\","
              + "\"producer\":\"producer1\",\"additionalMetadata\":{\"key1\":\"value1\",
              + \"key2\":\"value2\", \"key3\":3.1}}, {\"topic\":\"topic2\",\"data\":\"data2\","
              + "\"additionalMetadata\":{\"key3\":\"value3\",\"key4\":\"value4\"}}]}"
          

Returns:

List of events.

Since:

Foundry V8 SP4 FP3 (8.4.3) release