com.apama.correlator.jms
Event JMSReceiver


An event object representing an existing JMS receiver.

A receiver listeners for messages on a specific JMS queue or topic, maps them to Apama events and sends them to the Correlator's public contexts.
Action Summary
 stringgetReceiverId()

Returns the unique identifier of this receiver.
 voidremove()

Requests removal of this JMS receiver.
 
Action Detail

getReceiverId

string getReceiverId()
Returns the unique identifier of this receiver.

remove

void remove()
Requests removal of this JMS receiver.

The removal will be performed asynchronously, and completes after all events already received from this JMS destination have been enqueued to the Correlator, any persisted uniqueMessageIds no longer required for duplicate detection have been deleted, any durable topic subscription has been removed from the JMS broker, and the associated JMS consumer and session have been closed.

EPL applications may listen for the REMOVED JMSReceiverStatus event to detect when the removal has completed.

If the connection is currently down there could be an unbounded delay in completing the removal of the receiver.

It is an error to attempt to remove a JMS receiver that does not exist, or to attempt to remove a static JMS receiver. Such errors will result in the termination of the current EPL monitor instance.
See Also:
com.apama.correlator.jms.JMSReceiverStatus#REMOVED -