com.ibm.websphere.sib.api.jms
Interface JmsDestination
- public interface JmsDestination
- extends javax.jms.Destination, java.io.Serializable, javax.naming.Referenceable
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getBusName()
Get the name of the bus on which this JMS Destination resides.
|
|
getDeliveryMode()
Get the deliveryMode.
|
|
getDestDiscrim()
Retrieves the discriminator associated with this Destination.
|
|
getDestName()
Retrieves the name of the underlying destination to which this
javax.jms.Destination refers.
|
|
getPriority()
Get the priority.
|
|
getReadAhead()
Retrieve the current setting for the ReadAhead property for this
JmsDestination.
|
|
getTimeToLive()
Get the timeToLive that will be used for all messages sent using
this destination.
|
|
setBusName(java.lang.String busName)
Set the name of the bus on which this JMS Destination resides.
|
|
setDeliveryMode(java.lang.String deliveryMode)
Set the deliveryMode.
|
|
setPriority(java.lang.Integer priority)
Set the priority to be used for all messages sent using this Destination.
|
|
setReadAhead(java.lang.String value)
Set the required value for ReadAhead on all consumers created using
this JmsDestination.
|
|
setTimeToLive(java.lang.Long timeToLive)
Set the timeToLive (in milliseconds) to be used for all messages sent
using this destination.
|
Methods inherited from interface javax.naming.Referenceable |
---|
getReference |
Method Detail
getDestName
- java.lang.String getDestName()
getDestDiscrim
- java.lang.String getDestDiscrim( )
Note that for Queue objects the returned value will always be null, while for Topics it represents the name of the topic within the topic space.
setDeliveryMode
- void setDeliveryMode(java.lang.String deliveryMode)
- throws javax.jms.JMSException
The deliveryMode for sending messages may be overridden with this property. Valid values are:
Value | Constant name in ApiJmsConstants | Meaning |
Application | DELIVERY_MODE_APP | The deliveryMode is determined by the application (default) |
Persistent | DELIVERY_MODE_PERSISTENT | All messages will be sent persistent, irrespective of any settings in the application. |
NonPersistent | DELIVERY_MODE_NONPERSISTENT | All messages will be sent non-persistent, irrespective of any settings in the application. |
deliveryMode
- the deliveryMode to be used by MessageProducers of
this Destination. javax.jms.JMSException
- if the String is not one of the predefined values. MessageProducer
getDeliveryMode
- java.lang.String getDeliveryMode( )
setTimeToLive
- void setTimeToLive(java.lang.Long timeToLive)
- throws javax.jms.JMSException
A value of 0 means that the message will never expire. The default for this property is null, which allows the application to determine the timeToLive.
For compatibility with MQJMS, the value of -2 is treated in the same way as null.
The maximum value that will be accepted for timeToLive is defined in ApiJmsConstants.MAX_TIME_TO_LIVE.
timeToLive
- The time in milliseconds that the message should
live before expiry. javax.jms.JMSException
- if the value provided is not valid. getTimeToLive
- java.lang.Long getTimeToLive()
setPriority
- void setPriority(java.lang.Integer priority)
- throws javax.jms.JMSException
The valid parameters to this method are integers 0 to 9 inclusive, which will be used as the priority for messages sent using this destination.
The default value for this property is null, which indicates that the priority of the message will be set by the application.
For compatibility with MQJMS, the value of -2 will be treated in the same way as null.
priority
- The priority to be used for messages sent using this Destination. javax.jms.JMSException
- If the value provided is not valid. getPriority
- java.lang.Integer getPriority()
setReadAhead
- void setReadAhead(java.lang.String value)
- throws javax.jms.JMSException
Please see JmsConnectionFactory.setReadAhead(String)
for information
on the effect of the ReadAhead property.
Permitted values for the ReadAhead property of a JmsDestination are
as follows;
-
ApiJmsConstants.READ_AHEAD_AS_CONNECTION
- The default behaviour, where the value is inherited from the value set on the JmsConnectionFactory at the time that the Connection was created. -
ApiJmsConstants.READ_AHEAD_ON
- All consumers created using this JmsDestination will have ReadAhead turned on. -
ApiJmsConstants.READ_AHEAD_OFF
- All consumers created using this JmsDestination will have ReadAhead turned off.
Note that the value specified will override the value specified on the JmsConnectionFactory if the AS_CONNECTION value is not specified.
value
- The required value for ReadAhead on this JmsDestination javax.jms.JMSException
- If the value specified is not one of the supported constants. getReadAhead
- java.lang.String getReadAhead()
getBusName
- java.lang.String getBusName()
setBusName
- void setBusName(java.lang.String busName)
- throws javax.jms.JMSException
javax.jms.JMSException