Represents a notification emitted by an MBean. More...

#include <SPL/Runtime/Operator/Control/Notification.h>

Inheritance diagram for SPL::Notification:

[legend]

Public Member Functions

Notification (Notification const &n)

Notification (std::string const &type, std::string const &source, uint64_t sequenceNumber)

Notification (std::string const &type, std::string const &source, uint64_t sequenceNumber, std::string const &message)

Notification (std::string const &type, std::string const &source, uint64_t sequenceNumber, timestamp const &timeStamp)

Notification (std::string const &type, std::string const &source, uint64_t sequenceNumber, timestamp const &timeStamp, std::string const &message)

Notification (std::string const &type, std::string const &source, uint64_t sequenceNumber, timestamp const &timeStamp, std::string const &message, std::string const &userData)

const Notification & operator= (const Notification &n)

void setSource (std::string const &source)

uint64_t getSequenceNumber () const

void setSequenceNumber (uint64_t sequenceNumber)

std::string getType () const

timestamp getTimeStamp () const

void setTimeStamp (timestamp const &timeStamp)

std::string getMessage () const

std::string getUserData () const

std::string getSource () const

void setUserData (std::string const &userData)

std::string toString () const

Friends

std::ostream & operator<< (std::ostream &o, Notification const &n)

Detailed Description

Represents a notification emitted by an MBean.

A Notification contains a type, sequence number, timestamp and, optionally, specific user data represented as std::string, and a message. The notification source is the object name of the MBean which emitted the notification.

Since: InfoSphere® Streams Version 4.0.0.

Constructor & Destructor Documentation

SPL::Notification::Notification ( Notification const & n )

inline

Copy constructor.

SPL::Notification::Notification ( std::string const & type,

std::string const & source,

uint64_t sequenceNumber

)

inline

Creates a Notification object.

The notification timeStamp is set to the current time.

Parameters

type The notification type.

source The notification source.

sequenceNumber The notification sequence number within the source object.

SPL::Notification::Notification ( std::string const & type,

std::string const & source,

uint64_t sequenceNumber,

std::string const & message

)

inline

Creates a Notification object with message.

The notification timeStamp is set to the current time.

Parameters

type The notification type.

source The notification source.

sequenceNumber The notification sequence number within the source object.

message The detailed message.

SPL::Notification::Notification ( std::string const & type,

std::string const & source,

uint64_t sequenceNumber,

timestamp const & timeStamp

)

inline

Creates a Notification object.

Parameters

type The notification type.

source The notification source.

sequenceNumber The notification sequence number within the source object.

timeStamp It indicates when the notification was generated.

SPL::Notification::Notification ( std::string const & type,

std::string const & source,

uint64_t sequenceNumber,

timestamp const & timeStamp,

std::string const & message

)

inline

Creates a Notification object.

Parameters

type The notification type.

source The notification source.

sequenceNumber The notification sequence number within the source object.

timeStamp It indicates when the notification was generated.

message The detailed message.

SPL::Notification::Notification ( std::string const & type,

std::string const & source,

uint64_t sequenceNumber,

timestamp const & timeStamp,

std::string const & message,

std::string const & userData

)

inline

Creates a Notification object.

Parameters

type The notification type.

source The notification source.

sequenceNumber The notification sequence number within the source object.

timeStamp It indicates when the notification was generated.

message The detailed message.

userData The user data object.

Member Function Documentation

const Notification& SPL::Notification::operator= ( const Notification & n )

inline

void SPL::Notification::setSource ( std::string const & source )

inline

Set the source.

Parameters

source The source for this object.

See Also: getSource

uint64_t SPL::Notification::getSequenceNumber ( ) const

inline

Get the notification sequence number.

The sequence number is a serial number identifying a particular instance of notification in the context of the notification source. The notification model does not assume that notifications will be received in the same order that they are sent. The sequence number helps listeners to sort received notifications.

Returns: The notification sequence number within the source object.

See Also: setSequenceNumber

void SPL::Notification::setSequenceNumber ( uint64_t sequenceNumber )

inline

Set the notification sequence number.

The sequence number is a serial number identifying a particular instance of notification in the context of the notification source.

Parameters

sequenceNumber The notification sequence number within the source object.

See Also: getSequenceNumber

std::string SPL::Notification::getType ( ) const

inline

Get the notification type.

This is a string expressed in a dot notation similar to Java properties. It is recommended that the notification type should follow the reverse-domain-name convention used by Java package names. An example of a notification type is com.acme.streams.router.alarm.

Returns: The notification type.

timestamp SPL::Notification::getTimeStamp ( ) const

inline

Get the notification timestamp.

When converted from a JMX Notification, the Java timestamp value is interpreted as the number of milliseconds since the Unix Epoch, January 1, 1970, 00:00:00 GMT (as returned by java.util.Date.getTime()), and the machineId field is set to 0.

Returns: The notification timestamp as an SPL timestamp type.

See Also: setTimeStamp

void SPL::Notification::setTimeStamp ( timestamp const & timeStamp )

inline

Set the notification timestamp.

The timestamp indicates when the notification was generated.

Parameters

timeStamp The notification timestamp.

See Also: getTimeStamp

std::string SPL::Notification::getMessage ( ) const

inline

Get the notification message.

Returns: The message string of this notification object.

std::string SPL::Notification::getUserData ( ) const

inline

Get the user data.

This is used for whatever data the notification source wishes to communicate to its consumers. For JMX Notifications, this function returns the toString() value of the Java Notification's user data. An empty C++ string is returned if the Java Notification user data is null.

Returns: A string representation of the user data.

See Also: setUserData

std::string SPL::Notification::getSource ( ) const

inline

Get the notification source.

If the source is an MXBean then this function returns the canonical form of the source's ObjectName (see javax.management.ObjectName.getCanonicalName()).

Returns: The notification source.

void SPL::Notification::setUserData ( std::string const & userData )

inline

Set the user data.

Parameters

userData The user data object. It is used for whatever data the notification source wishes to communicate to its consumers.

See Also: getUserData

std::string SPL::Notification::toString ( ) const

inline

Returns a string representation of this notification.

Returns: A string representation of this notification.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream & o,

Notification const & n

)

friend

Print internal state through the << operator.

Parameters

o output stream.

n The Notification object.

The documentation for this class was generated from the following file:

SPL/Runtime/Operator/Control/Notification.h