Universal Messaging Service MBean

Attribute

Description

name

String. The name of the service.

usage

String. The usage of the service. Values are:

SourceOnly - you can subscribe to the service, but you cannot use the service to send events.

DestinationOnly - you can use the service to only send events.

SourceAndDestination - you can both subscribe to the service and use the service to send events.

For information about the possible usage of a service, see Configuring Service Groups.

providerUrl

String. The URL of the Universal Messaging server. The providerUrl attribute has the following format: protocol://host: port. The default value is nsp://localhost:9000.

connected

Boolean. Indicates whether the service is connected to the configured Universal Messaging server.

connectTime

Instant. The time when the service connected to the Universal Messaging server, or reconnected to the server after losing connection.

disconnectTime

Instant. The time when the service disconnected from the Universal Messaging server.

activeSharedDurable-SubscribersCount

Integer. The number of active shared durable subscribers to the service. If the service usage is DestinationOnly, the value of this attribute is empty.

activeSharedDurable-SubscribersIds

List<String>. The identifiers of the active shared durable subscribers to the service. If the service usage is DestinationOnly, the value of this attribute is empty.

inactiveSharedDurable-SubscribersCount

Integer. The number of shared durable subscribers to this service that are inactive but still subscribed. If the service usage is DestinationOnly, the value of this attribute is empty.

Important:

The system keeps inactive subscribers only while DES is running. If a shared durable subscriber is closed, but remains unsubscribed, the subscriber ID is added to the inactiveSharedDurableSubscribersIds, list and inactiveSharedDurableSubscribersCount increases. However, when you restart the runtime where DES is embedded, DES will not examine the Universal Messaging channel for available shared named objects. As a result, the inactiveSharedDurableSubscribersIds list is initially be empty and does not contain the subscriber ID that was previously added.

inactiveSharedDurable-SubscribersIds

List<String>. The identifiers of the shared durable subscriber to the service that are inactive, but still unsubscribed. If the service usage is DestinationOnly, the value of this attribute is empty.

Important:

nonDurable-SubscribersCount

Integer. The number of non-durable subscribers to the service. If the service usage is DestinationOnly, the value of this attribute is empty.

receivedEvents

Long. The number of events received by all subscribers to the service since the service became active. If the service usage is DestinationOnly, the value of this attribute is empty.

lastSendingStatus

String. The status of the last sending operation performed by the service. Values are:

Green - when the Universal Messaging server or the network connection to the server is slow, and transactions take a long time.

Red - when the Universal Messaging server or the network connection the server is so slow that transactions fail due to a timeout.

Important:

If the Universal Messaging server becomes unavailable, but no events are sent for long time, the lastSendingStatus might still be Green because the status is updated only after a transaction to the server.

To determine whether the server is available without sending events, check the connected, connectTime, and disconnectTime attributes.

lastSendingStatusDetails

String. Information about the last sending status. If the status is Red, the explanation also contains the exception that caused the sending operation to fail.

sentEvents

Long. The number of events sent to the service. If the service usage is SourceOnly, the value of this attribute is empty.

acknowledgedSentEvents

Long. The number of events sent to the service and successfully acknowledged by the Universal Messaging server. If the service usage is SourceOnly, the value of this attribute is empty.

lastSendingTime

Instant. The time when the last event was sent to the Universal Messaging server.

Note:

The lastSendingTime attribute reflects the time when an event was last sent to the destination service. The lastSendingTime attribute does not carry information about whether an event was acknowledged by the destination service.

To see whether an event was acknowledged by the destination service, check the lastCompletedAcknowledgementTime attribute.

lastCompletedAcknowled-gementTime

Instant. The last time when an event sent to the service was successfully acknowledged by the Universal Messaging server. If the service usage is SourceOnly, the value of this attribute is empty.

regularDelivery-InterruptionsCount

Integer. The number of times when the service switched to redelivery mode because of a failure to deliver an event to the Universal Messaging server. If the service usage is SourceOnly, the value of this attribute is empty.