JMSSenderStatus

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.11.3.3

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.correlator.jms
Event JMSSenderStatus

A notification event sent to an EPL application when a configured JMS sender has been created successfully, encounters an error, or is removed.

This event includes string constants for each supported status, and fields specifying information about the configuration of this sender (as specified when it was created).

Note that all notification events will be held back until JMS.onApplicationInitialized() has been called.

JMSSenderStatus events are sent for both static senders in the configuration file (or the implicitly defined default sender), and dynamic senders created with JMSConnection.addSender.

Constant summary
`string`	`CONNECTING := "CONNECTING"` The status value indicating that the sender is waiting for the JMS connection or sender session to be established.
`string`	`ERROR := "ERROR"` The status value indicating that the sender is not available due to some non-fatal error condition; the Correlator-JMS runtime will keep retrying in the background.
`string`	`FATAL_ERROR := "FATAL_ERROR"` The status value indicating that the sender is not available due to a fatal error condition.
`string`	`OK := "OK"` The status value indicating that the sender is fully connected to the JMS broker with a valid JMS Producer object, and is available to send messages.
`string`	`REMOVED := "REMOVED"` The status value indicating that the removal of a dynamic sender has been completed, which will be sent some time after a sender removal request, once all the associated state on the broker and the Correlator's database has been removed.

Member summary
`string`	`connectionId` The unique identifier of the JMS connection.
`string`	`senderId` The unique identifier of this sender.
`string`	`status` An enumeration value specifying the status of the sender. The values in the enumeration are provided as constants in this event.
`string`	`errorMessage` A user-readable string specifying the cause of the error. This is guaranteed not empty if status="ERROR" or "FATAL_ERROR".
`dictionary<string, string>`	`extraStatusInfo` Additional status information items. None are currently supported.
`string`	`senderReliability` Sender quality of service, specifying the reliability mode of the messages from this sender.
`dictionary<string, string>`	`extraAddParams` Additional sender configuration parameters specified when it was added.

Constant detail

CONNECTING

            string CONNECTING := "CONNECTING"

The status value indicating that the sender is waiting for the JMS connection or sender session to be established.

ERROR

            string ERROR := "ERROR"

The status value indicating that the sender is not available due to some non-fatal error condition; the Correlator-JMS runtime will keep retrying in the background.

FATAL_ERROR

            string FATAL_ERROR := "FATAL_ERROR"

The status value indicating that the sender is not available due to a fatal error condition.

Senders in this state are no longer useful and should be removed by the EPL application (if dynamic) or the system administrator (if statically defined in the XML config file). Note that the removal of such failed senders does not happen automatically.

OK

            string OK := "OK"

The status value indicating that the sender is fully connected to the JMS broker with a valid JMS Producer object, and is available to send messages.

REMOVED

            string REMOVED := "REMOVED"

The status value indicating that the removal of a dynamic sender has been completed, which will be sent some time after a sender removal request, once all the associated state on the broker and the Correlator's database has been removed.

In rare cases it's possible that a status event for a sender may be sent after the REMOVED status; any such event should be ignored.

Member detail

connectionId

            string connectionId

The unique identifier of the JMS connection.

errorMessage

            string errorMessage

A user-readable string specifying the cause of the error. This is guaranteed not empty if status="ERROR" or "FATAL_ERROR".

extraAddParams

            dictionary<string, string> extraAddParams

Additional sender configuration parameters specified when it was added.

extraStatusInfo

            dictionary<string, string> extraStatusInfo

Additional status information items. None are currently supported.

senderId

            string senderId

The unique identifier of this sender.

senderReliability

            string senderReliability

Sender quality of service, specifying the reliability mode of the messages from this sender.

One of the enumeration constants from the JMSSenderReliability event.

status

            string status

An enumeration value specifying the status of the sender. The values in the enumeration are provided as constants in this event.

If the status is OK then the sender is functioning correctly; if it is REMOVED then removal of the sender has completed.