com.ibm.websphere.sib.api.jms
Interface JmsQueue
- public interface JmsQueue
- extends javax.jms.Queue, JmsDestination
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getGatherMessages()
Get the current setting for the GatherMessages property for this JMSQueue.
|
|
getProducerBind()
Get the current setting for the ProducerBind property for this JMSQueue.
|
|
getProducerPreferLocal()
Get the current setting for the ProducerPreferLocal property for this JMSQueue.
|
|
getQueueName()
Get the QueueName for this queue.
|
|
getScopeToLocalQP()
Get the current setting for the ScopeToLocalQP property for this JMSQueue.
|
|
setGatherMessages(java.lang.String gatherMessages)
Set whether messages on all queue points or only a single queue point are
visible to MessageConsumers and QueueBrowsers using this JMSQueue.
|
|
setProducerBind(java.lang.String bind)
Set whether messages sent by a single MessageProducer to this JMSQueue will go to the
same queue point, or whether no such restriction will be applied, and different messages
will be sent to different queue points.
|
|
setProducerPreferLocal(java.lang.String preferLocal)
Set whether a MessageProducer for this JMSQueue should prefer a locally
connected queue point of the queue destination over any other queue points.
|
|
setQueueName(java.lang.String queueName)
Set the QueueName for this queue.
|
|
setScopeToLocalQP(java.lang.String scopeToLocalQP)
Set whether the SIB queue destination identified by this JMSQueue is dynamically
scoped to a single queue point if one exists on the messaging engine that the
application is connected to.
|
Methods inherited from interface javax.jms.Queue |
---|
toString |
Methods inherited from interface com.ibm.websphere.sib.api.jms.JmsDestination |
---|
getBusName, getDeliveryMode, getDestDiscrim, getDestName, getPriority, getReadAhead, getTimeToLive, setBusName, setDeliveryMode, setPriority, setReadAhead, setTimeToLive |
Methods inherited from interface javax.naming.Referenceable |
---|
getReference |
Method Detail
getQueueName
- java.lang.String getQueueName()
- throws javax.jms.JMSException
getQueueName
in interface javax.jms.Queue
javax.jms.JMSException
- if there is a problem returning this property. setQueueName
- void setQueueName(java.lang.String queueName)
- throws javax.jms.JMSException
queueName
- javax.jms.JMSException
- if there is a problem setting this property. setScopeToLocalQP
- void setScopeToLocalQP(java.lang.String scopeToLocalQP)
- throws javax.jms.JMSException
If the destination is scoped to the local queue point all operations performed on this JMSQueue object will be limited to the local queue point and behave as if the queue consists of this single queue point. This includes message production, message consumption and message browsing, both by this application and any JMS application that receives a message containing this JMSQueue as the JMSReplyTo property.
If the connected messaging engine does not own a queue point of the destination this property is ignored.
If the queue destination has a single queue point this property is ignored.
If the queue destination resides in a different bus from the one that the application is connected to, this option has no effect on the choice of the destinations queue points.
Permitted values for the scopeToLocalQP property are as follows;
-
_TO_LOCAL_QP_ON
Scope operations to a local queue point (if configured) -
ApiJmsConstants.SCOPE_TO_LOCAL_QP_OFF
Do not scope operations to a local queue point (default)
This property was introduced in WebSphere Application Server V7
scopeToLocalQP
- Should scoping be performed. javax.jms.JMSException
- If a validation failure occurs. getScopeToLocalQP
- java.lang.String getScopeToLocalQP( )
setProducerPreferLocal
- void setProducerPreferLocal(java.lang.String preferLocal)
- throws javax.jms.JMSException
This property indicates whether a queue point on the connected messaging engine is preferred over any other queue points unless the local one is unable to accept messages at the time that they are sent. If the local queue point is unable to accept messages then workload balancing of messages will occur across all available queue points.
If the connected messaging engine does not own a queue point of the destination this property is ignored.
If the queue destination has a single queue point this property is ignored.
If the queue destination resides in a different bus from the one that the application is connected to, this option has no effect on the choice of the destinations queue points.
Permitted values for the preferLocal property are as follows;
-
ApiJmsConstants.PRODUCER_PREFER_LOCAL_ON
An available queue point on the connected messaging engine is preferred when sending messages (default) -
PRODUCER_PREFER_LOCAL_OFF
A queue point on the connected messaging engine is not preferred over any others
This property was introduced in WebSphere Application Server V7
preferLocal
- Should a local queue point be preferred. javax.jms.JMSException
- If a validation failure occurs. getProducerPreferLocal
- java.lang.String getProducerPreferLocal( )
setProducerBind
- void setProducerBind(java.lang.String bind)
- throws javax.jms.JMSException
This option only applies to MessageProducers where the queue is identified at the time the MessageProducer is created, not at the time of sending messages.
If the queue destination has a single queue point this property is ignored.
If the queue destination resides in a different bus from the one that the application is connected to, this option has no effect on the choice of the destinations queue points.
Permitted values for the bind property are as follows;
-
ApiJmsConstants.PRODUCER_BIND_ON
Send all messages to the same queue point -
ApiJmsConstants.PRODUCER_BIND_OFF
Allow messages to be sent to different queue points (default)
This property was introduced in WebSphere Application Server V7
bind
- Should all messages be sent to the same queue point. javax.jms.JMSException
- If a validation failure occurs. getProducerBind
- java.lang.String getProducerBind( )
setGatherMessages
- void setGatherMessages(java.lang.String gatherMessages)
- throws javax.jms.JMSException
Enabling this property indicates that MessageConsumers and QueueBrowsers should have messages from all queue points of this queue destination visible to them for consuming or browsing. Disabling this property indicates that only messages from a single queue point are visible to MessageConsumers and QueueBrowsers. If the latter, a queue point on the messaging engine that the application is connected to is preferred, if no such queue point exists the system will choose a queue point from those available.
If the queue destination has a single queue point this property is ignored.
Permitted values for the gatherMessages property are as follows;
-
ApiJmsConstants.GATHER_MESSAGES_ON
Allow gathering of messages from any available queue point -
ApiJmsConstants.GATHER_MESSAGES_OFF
Only process messages from the attached queue point (default)
This property was introduced in WebSphere Application Server V7
gatherMessages
- Should messages be gathered from all queue points. javax.jms.JMSException
- If an invalid value is specified. getGatherMessages
- java.lang.String getGatherMessages( )