Package net.sf.eBusx.monitor

Class MonitorUpdate

java.lang.Object

net.sf.eBus.messages.EMessageObject

net.sf.eBus.messages.EMessage

net.sf.eBus.messages.ENotificationMessage

net.sf.eBusx.monitor.MonitorUpdate

All Implemented Interfaces:

java.io.Serializable

public final class MonitorUpdate
extends ENotificationMessage
implements java.io.Serializable

Reports the registration, deregistration, an eBus object's change in on-going status, or an eBus object's transient event. See each field's documentation for more information.

In order to receive this notification message, subscribe to: net.sf.eBusx.monitor.MonitorUpdate:/eBus/monitor/update/<host>/<app> where <host> is Monitor.hostName() and <app> is Monitor.applicationName().

Author:

Charles Rapp

See Also:

ApplicationInfo, Monitor, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MonitorUpdate.Builder	Builder for creating MonitorUpdate notification.
static class	MonitorUpdate.UpdateType	MonitorUpdate has four types: object registration, on-going status update, transient status update, and object de-registration.

Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage

EMessage.MessageType

Field Summary

Fields

Modifier and Type	Field	Description
ActionLevel	actionLevel	Action level associated with update type.
java.lang.String	actionMessage	Optional human-readable text associated with action name providing further explanation.
java.lang.String	actionName	Action name associated with update type.
java.lang.String	appName	Application name.
java.lang.String	hostName	Application is running on this host.
MonitorId	instance	Registered eBus object's unique identifier.
MonitorUpdate.UpdateType	updateType	Specifies update is for either object registration, on-going status update, transient status update, and de-registration.

Fields inherited from class net.sf.eBus.messages.ENotificationMessage

NO_PUB_ID, position, publisherId

Fields inherited from class net.sf.eBus.messages.EMessage

MAX_SUBJECT_LENGTH, subject, timestamp

Method Summary

Modifier and Type	Method	Description
static MonitorUpdate.Builder	builder()
java.lang.String	toString()	Returns notification message publisher ID and position as a string.

Methods inherited from class net.sf.eBus.messages.ENotificationMessage

equals, hashCode

Methods inherited from class net.sf.eBus.messages.EMessage

isApplicationMessage, isSystemMessage, key, messageType, timestampAsInstant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

hostName

public final java.lang.String hostName

Application is running on this host. Note: this name is not not required to be a network host name but should be a name meaningful to the application and those monitoring it.

appName

public final java.lang.String appName

Application name. This name should be meaningful both to the application and those monitoring it.

instance

public final MonitorId instance

Registered eBus object's unique identifier.

updateType

public final MonitorUpdate.UpdateType updateType

Specifies update is for either object registration, on-going status update, transient status update, and de-registration.

actionLevel

public final ActionLevel actionLevel

Action level associated with update type.

actionName

public final java.lang.String actionName

Action name associated with update type. Will not be null or empty.

actionMessage

@Nullable
public final java.lang.String actionMessage

Optional human-readable text associated with action name providing further explanation.

Method Detail

toString

public java.lang.String toString()

Description copied from class: ENotificationMessage

Returns notification message publisher ID and position as a string.

Overrides:

toString in class ENotificationMessage

Returns:

notification message publisher ID and position as a string.

builder

public static MonitorUpdate.Builder builder()