PersistentStatusMessage (eBus 7.4.0 API)

java.lang.Object
- net.sf.eBus.messages.EMessageObject
- - net.sf.eBus.messages.EMessage
  - - net.sf.eBus.messages.ENotificationMessage
    - - net.sf.eBusx.monitor.PersistentStatusMessage

All Implemented Interfaces:

java.io.Serializable
```
public final class PersistentStatusMessage
extends ENotificationMessage
implements java.io.Serializable
```
Reports a monitorable object's on-going status. This status is in effect until further notice. The notification subject is the MonitorId.typeName and MonitorId.instanceName in the format "<type name>.<instance name>". This means that in order to subscribe to this notification, you must first request the registered monitored objects using the MonitoredObjectRequest message.

Author:

Charles Rapp

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PersistentStatusMessage.Builder
Builder class used to construct a persistent status message.
- Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage
  EMessage.MessageType

Field Summary

Fields
Modifier and Type	Field	Description
`ActionLevel`	`actionLevel`	The instance on-going action level.
`java.lang.String`	`actionMessage`	Optional message explaining the action.
`java.lang.String`	`actionName`	The on-going action name.
`java.lang.String`	`appName`	Application name.
`java.lang.String`	`hostName`	Application is running on this host.
`MonitorId`	`instance`	The monitored object's unique identifier.

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PersistentStatusMessage.Builder`	`builder()`	Returns a new instance of persistent status message builder.
`java.lang.String`	`toString()`	Returns the application information message as text.

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
```
    The monitored object's unique identifier.
  - actionLevel
```
public final ActionLevel actionLevel
```
    The instance on-going action level.
  - actionName
```
public final java.lang.String actionName
```
    The on-going action name.
  - actionMessage
```
public final java.lang.String actionMessage
```
    Optional message explaining the action.
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Returns the application information message as text.
    
    Overrides:
    
    toString in class ENotificationMessage
    
    Returns:
    
    textual representation of application information.
  - builder
```
public static PersistentStatusMessage.Builder builder()
```
    Returns a new instance of persistent status message builder.
    
    Returns:
    
    persistent status message builder.