Package net.sf.eBusx.monitor
Class ApplicationInfo
- java.lang.Object
-
- net.sf.eBus.messages.EMessageObject
-
- net.sf.eBus.messages.EMessage
-
- net.sf.eBus.messages.ENotificationMessage
-
- net.sf.eBusx.monitor.ApplicationInfo
-
- All Implemented Interfaces:
java.io.Serializable
public final class ApplicationInfo extends ENotificationMessage implements java.io.Serializable
Reports the application information. This includes the application name, version, copyright, description and user-defined attributes. These attributes are defined by creating anEField
sub-class. See thenet.sf.eBus.messages
package documentation for more information about sub-classingEField
.In order to receive this message, subscribe to:
net.sf.eBusx.monitor.ApplicationInfo
:/eBus/monitor/update/<host>/<app>
where <host> isMonitor.hostName()
and <app> isMonitor.applicationName()
.- Author:
- Charles Rapp
- See Also:
MonitorUpdate
,ApplicationInfoRequest
,ApplicationInfoReply
,Monitor
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ApplicationInfo.Builder
Builder class used to construct anApplicationInfo
instance.-
Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage
EMessage.MessageType
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.String
appName
Application name.java.lang.String
appVersion
The application version.EField
attributes
The application-specific attributes.java.lang.String
copyright
The application copyright information.java.lang.String
description
Optional human-readable description of this application.java.lang.String
hostName
Application is running on this host.-
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 ApplicationInfo.Builder
builder()
Returns theApplicationInfo
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
-
-
-
-
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.
-
appVersion
public final java.lang.String appVersion
The application version.
-
copyright
@Nullable public final java.lang.String copyright
The application copyright information.
-
description
@Nullable public final java.lang.String description
Optional human-readable description of this application.
-
attributes
@Nullable public final EField attributes
The application-specific attributes.
-
-
Method Detail
-
toString
public java.lang.String toString()
Returns the application information message as text.- Overrides:
toString
in classENotificationMessage
- Returns:
- textual representation of application information.
-
builder
public static ApplicationInfo.Builder builder()
Returns theApplicationInfo
message builder.- Returns:
- message builder.
-
-