JMS

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 JMS

The top-level event object representing the Correlator-integrated JMS runtime.

Action summary
`com.apama.correlator.jms.JMSConnection`	`static` `getConnection(string connectionId)` Get a JMSConnection event object representing a connection defined in the XML configuration file.
`com.apama.correlator.jms.JMSReceiver`	`static` `getReceiver(string receiverId)` Get a JMSReceiver event object representing a receiver that already exists, which might have been added dynamically, or defined statically in the XML configuration file.
`com.apama.correlator.jms.JMSSender`	`static` `getSender(string senderId)` Get a JMSSender event object representing a sender that already exists, which might have been added dynamically, or defined statically in the XML configuration file.
`void`	`static` `onApplicationInitialized()` Should be called by EPL applications after all EPL has been injected and initialized, to indicate that the application is ready to receive events from the JMS runtime, such as received JMS messages and status notification events.

Action detail

getConnection

            com.apama.correlator.jms.JMSConnection static getConnection(string connectionId)

Get a JMSConnection event object representing a connection defined in the XML configuration file.

Parameters:: connectionId

getReceiver

            com.apama.correlator.jms.JMSReceiver static getReceiver(string receiverId)

Get a JMSReceiver event object representing a receiver that already exists, which might have been added dynamically, or defined statically in the XML configuration file.

It is the caller's responsibility to specify a valid receiverId - the specified identifier is not be validated as part of this action call. If the identifier does not represent an existing receiver then operations on the returned JMSReceiver (such as remove()) will cause an error.

Parameters:: receiverId

getSender

            com.apama.correlator.jms.JMSSender static getSender(string senderId)

Get a JMSSender event object representing a sender that already exists, which might have been added dynamically, or defined statically in the XML configuration file.

It is the caller's responsibility to specify a valid senderId - the specified identifier is not be validated as part of this action call. If the identifier does not represent an existing sender then operations on the returned JMSSender (such as remove()) will cause an error.

Parameters:: senderId

onApplicationInitialized

            void static onApplicationInitialized()

Should be called by EPL applications after all EPL has been injected and initialized, to indicate that the application is ready to receive events from the JMS runtime, such as received JMS messages and status notification events.

Invoking this action more than once will have no effect.