com.apama.correlator.jms
Event JMSReceiverConfiguration


An event object representing the configuration of a new JMS receiver, for dynamically adding JMS receivers at runtime.

Call JMSConnection.createReceiverConfiguration() to create an instance, and then use the setter actions to specify each required configuration option. Each setter method returns this configuration instance to make it possible to chain calls and specify all required options in a single statement.
See Also:
com.apama.correlator.jms.JMSConnection#createReceiverConfiguration() - Creates a new JMSReceiverConfiguration event object.
com.apama.correlator.jms.JMSConnection#addReceiverWithConfiguration() - Uses a JMSReceiverConfiguration to add a new JMS receiver.

Action summary
 stringgetConnectionId()

The identifier of the connection this receiver belongs to.
 stringgetDestination()

The queue or topic this receiver will listen to.
 stringgetDupDetectionDomainId()

Specifies an application-defined identifier to override how receivers are grouped together for duplicate-detection purposes when using EXACTLY_ONCE reliability.
 stringgetDurableTopicSubscriptionName()

Specifies the unique identifier for the subscription if a durable topic subscription is to be created.
 stringgetMessageSelector()

Specifies the JMS message selector query string to select a subset of queue/topic messages to be processed by this receiver.
 booleangetNoLocal()

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

The unique identifier of this receiver.
 stringgetReceiverReliability()

Specifies the reliability mode to use for receiving messages.
 com.apama.correlator.jms.JMSReceiverConfigurationsetDupDetectionDomainId(string value)

Specifies an application-defined identifier to override how receivers are grouped together for duplicate-detection purposes when using EXACTLY_ONCE reliability.
 com.apama.correlator.jms.JMSReceiverConfigurationsetDurableTopicSubscriptionName(string value)

Specifies the unique identifier for the subscription if a durable topic subscription is to be created.
 com.apama.correlator.jms.JMSReceiverConfigurationsetMessageSelector(string value)

Specifies the JMS message selector query string to select a subset of queue/topic messages to be processed by this receiver.
 com.apama.correlator.jms.JMSReceiverConfigurationsetNoLocal(boolean value)

Specifies that messages sent to this destination by our own connection should be ignored by the receiver.
 com.apama.correlator.jms.JMSReceiverConfigurationsetReceiverReliability(string value)

Specifies the reliability mode to use for receiving messages.
 
Action detail

getConnectionId

            string getConnectionId()
        
The identifier of the connection this receiver belongs to.

getDestination

            string getDestination()
        
The queue or topic this receiver will listen to.

getDupDetectionDomainId

            string getDupDetectionDomainId()
        
Specifies an application-defined identifier to override how receivers are grouped together for duplicate-detection purposes when using EXACTLY_ONCE reliability.

getDurableTopicSubscriptionName

            string getDurableTopicSubscriptionName()
        
Specifies the unique identifier for the subscription if a durable topic subscription is to be created.

getMessageSelector

            string getMessageSelector()
        
Specifies the JMS message selector query string to select a subset of queue/topic messages to be processed by this receiver.

getNoLocal

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

getReceiverId

            string getReceiverId()
        
The unique identifier of this receiver.

getReceiverReliability

            string getReceiverReliability()
        
Specifies the reliability mode to use for receiving messages.

setDupDetectionDomainId

            com.apama.correlator.jms.JMSReceiverConfiguration setDupDetectionDomainId(string value)
        
Specifies an application-defined identifier to override how receivers are grouped together for duplicate-detection purposes when using EXACTLY_ONCE reliability.
Parameters:
value - An arbitrary (but preferably short) string defined by the EPL application. All EXACTLY_ONCE receivers with this string will be grouped together to form a single duplicate detection domain.

This is an advanced feature - by default, receivers are grouped into a duplicate detection domain together with other receivers in the same connectionId listening to the same destination, which is the correct setting in the majority of cases.


setDurableTopicSubscriptionName

            com.apama.correlator.jms.JMSReceiverConfiguration setDurableTopicSubscriptionName(string value)
        
Specifies the unique identifier for the subscription if a durable topic subscription is to be created.
Parameters:
value - A unique JMS subscription name if a durable topic subscription should be created, or "" if a non-durable topic subscription should be made. Only valid for topics, and only if the reliability is not BEST_EFFORT.

setMessageSelector

            com.apama.correlator.jms.JMSReceiverConfiguration setMessageSelector(string value)
        
Specifies the JMS message selector query string to select a subset of queue/topic messages to be processed by this receiver.
Parameters:
value - A message selector string, or "" to receive all messages. See the JMS documentation for the javax.jms.Message interface for more details.

setNoLocal

            com.apama.correlator.jms.JMSReceiverConfiguration setNoLocal(boolean value)
        
Specifies that messages sent to this destination by our own connection should be ignored by the receiver.
Parameters:
value - May be set to true or false for topic destinations. If the destination is a queue, the behaviour of noLocal=true is not specified, and will not work with many providers. The default value of false is usually fine.

setReceiverReliability

            com.apama.correlator.jms.JMSReceiverConfiguration setReceiverReliability(string value)
        
Specifies the reliability mode to use for receiving messages.
Parameters:
value - Must be one of the enumeration constants from the JMSReceiverReliability event, or "" to indicate that the connection's defaultReceiverReliability should be used.
See Also:
com.apama.correlator.jms.JMSReceiverReliability -