JMSReceiverStatus

com.apama.correlator.jms
Event JMSReceiverStatus

A notification event sent to an EPL application when a configured JMS receiver 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 receiver (as specified when it was created).

Note that the ordering of JMSReceiverStatus events relative to received messages is not defined. Also note that notification events will be held back until JMS.onApplicationInitialized() has been called.

JMSReceiverStatus events are sent for both static receivers in the configuration file, and dynamic receivers created with JMSConnection.addReceiver.

Constant summary
`string`	`CONNECTING := "CONNECTING"` The status value indicating that the receiver is waiting for the JMS connection or receiver session to be established.
`string`	`DESTINATION_NOT_FOUND := "DESTINATION_NOT_FOUND"` The status value indicating the receiver could not be found because of a problem accessing the specified destination (i.e. a JMS or JNDI error).
`string`	`ERROR := "ERROR"` The status value indicating that the receiver 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 receiver is not available due to a fatal error condition.
`string`	`OK := "OK"` The status value indicating that the receiver is fully connected to the JMS broker with a valid JMS Consumer object, and is available to receive messages.
`string`	`REMOVED := "REMOVED"` The status value indicating that the removal of a dynamic receiver has been completed, which will be sent some time after a receiver removal request, once all the associated state on the broker and the Correlator's database has been removed.

Field summary
`string`	`connectionId` The unique identifier of the JMS connection.
`string`	`receiverId` The unique identifier of this receiver.
`string`	`status` An enumeration value specifying the status of the receiver. 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`	`destination` A JMS queue name, JMS topic name, or JNDI name, prefixed by `"queue:"`, `"topic:"` or `"jndi:"`.
`string`	`receiverReliability` Receiver quality of service, specifying the reliability mode used for receiving messages.
`string`	`durableTopicSubscriptionName` A unique JMS subscription name if a durable topic subscription should be created, or "" if a non-durable topic subscription should be made.
`string`	`messageSelector` JMS message selector string, to specify a subset of messages from the destination to be processed by this receiver.
`boolean`	`noLocal` Specifies that messages sent to this destination by our own connection should be ignored by the receiver.
`dictionary<string, string>`	`extraAddParams` Additional receiver configuration parameters. None currently supported.

Constant detail

CONNECTING

string CONNECTING := "CONNECTING"

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

DESTINATION_NOT_FOUND

string DESTINATION_NOT_FOUND := "DESTINATION_NOT_FOUND"

The status value indicating the receiver could not be found because of a problem accessing the specified destination (i.e. a JMS or JNDI error).

ERROR

string ERROR := "ERROR"

The status value indicating that the receiver 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 receiver is not available due to a fatal error condition.

Receivers 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). The removal of such failed receivers does not happen automatically.

OK

string OK := "OK"

The status value indicating that the receiver is fully connected to the JMS broker with a valid JMS Consumer object, and is available to receive messages.

REMOVED

string REMOVED := "REMOVED"

The status value indicating that the removal of a dynamic receiver has been completed, which will be sent some time after a receiver 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 receiver may be sent after the REMOVED status; any such event should be ignored.

Field detail

connectionId

string connectionId

The unique identifier of the JMS connection.

destination

string destination

A JMS queue name, JMS topic name, or JNDI name, prefixed by "queue:", "topic:" or "jndi:".

durableTopicSubscriptionName

string durableTopicSubscriptionName

A unique JMS subscription name if a durable topic subscription should be created, or "" if a non-durable topic subscription should be made.

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 receiver configuration parameters. None currently supported.

extraStatusInfo

dictionary<string, string> extraStatusInfo

Additional status information items. None are currently supported.

messageSelector

string messageSelector

JMS message selector string, to specify a subset of messages from the destination to be processed by this receiver.

noLocal

boolean noLocal

Specifies that messages sent to this destination by our own connection should be ignored by the receiver.

receiverId

string receiverId

The unique identifier of this receiver.

receiverReliability

string receiverReliability

Receiver quality of service, specifying the reliability mode used for receiving messages.

One of the enumeration constants from the JMSReceiverReliability event

status

string status

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

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

com.apama.correlator.jmsEvent JMSReceiverStatus