IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.sib.api.jms
Interface ApiJmsConstants


public interface ApiJmsConstants

This file contains constants which can be used by applications as parameters to provider specific JMS extension methods.

It also contains some system constants which are required for trace and NLS support.


Field Summary
static java.lang.String CHARSET_PROPERTY
          Name of the character set property.
static java.lang.String CONNECTION_PROXIMITY_BUS
          Default value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine in the specified bus.
static java.lang.String CONNECTION_PROXIMITY_CLUSTER
          Value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine on the same cluster as the client application.
static java.lang.String CONNECTION_PROXIMITY_HOST
          Value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine on the same host as the client application.
static java.lang.String CONNECTION_PROXIMITY_SERVER
          Value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine in the same server process.
static java.lang.String CONNFACTORY_FACTORY_CLASS
          This constant contains the name of the class which implements the JmsFactoryFactory interface.
static java.lang.String DELIVERY_MODE_APP
          DeliveryMode constant for Destinations.
static java.lang.String DELIVERY_MODE_NONPERSISTENT
          DeliveryMode constant for Destinations.
static java.lang.String DELIVERY_MODE_PERSISTENT
          DeliveryMode constant for Destinations.
static int ENC_FLOAT_IEEE_NORMAL
          NORMAL value of floating point encoding.
static int ENC_FLOAT_IEEE_REVERSED
          REVERSED value of floating point encoding.
static int ENC_FLOAT_MASK
          Mask for the float part of the JMS_IBM_Encoding field
static int ENC_FLOAT_S390
          S390 value of floating point encoding.
static int ENC_FLOAT_UNDEFINED
          UNDEFINED value of floating point encoding.
static int ENC_INTEGER_MASK
          Mask for the integer part of the JMS_IBM_Encoding field
static int ENC_INTEGER_NORMAL
          NORMAL value of integer encoding.
static int ENC_INTEGER_REVERSED
          REVERSED value of integer encoding.
static int ENC_INTEGER_UNDEFINED
          UNDEFINED value of integer encoding.
static java.lang.String ENCODING_PROPERTY
          Name of the encoding property.
static java.lang.String EXCEPTION_MAXTHREADS_DEFAULT_INT
          This constant defines the default number of threads which may be active concurrently, invoking JMS exception listeners.
static java.lang.String EXCEPTION_MAXTHREADS_NAME_INT
          This constant defines name of a tuning parameter.
static java.lang.String EXCEPTION_MESSAGE
          Name of the Exception Message property.
static java.lang.String EXCEPTION_PROBLEM_DESTINATION
          Name of the exception problem destination property.
static java.lang.String EXCEPTION_PROBLEM_SUBSCRIPTION
          Name of the exception problem subscription property.
static java.lang.String EXCEPTION_REASON
          Name of the Exception Reason property.
static java.lang.String EXCEPTION_THREADPOOL_NAME_INT
          This constant defines the name of the thread pool created to dispatch JMS Exceptions to applications.
static java.lang.String EXCEPTION_TIMESTAMP
          Name of the Exception Timestamp property.
static java.lang.String FEEDBACK_PROPERTY
          Name of the feedback property.
static java.lang.String FORMAT_PROPERTY
          Name of the Format property.
static java.lang.String GATHER_MESSAGES_OFF
          Constant used to indicate that only messages on the local queue point (hosted by the messaging engine to which the application is connected) of the SIB destination are visible to MessageConsumers and QueueBrowsers.
static java.lang.String GATHER_MESSAGES_ON
          Constant used to indicate that messages on all queue points of the SIB destination referenced by the JMS Queue are visible to MessageConsumers and QueueBrowsers.
static java.lang.String IBM_ARM_CORRELATOR
          Constant for accessing the IBM ARM correlator property.
static java.lang.String JMS_IBM_MQMD_CORRELID
          A constant for the JMS_IBM_MQMD_CorrelId property name.
static java.lang.String JMS_IBM_MQMD_MSGID
          A constant for the JMS_IBM_MQMD_MsgId property name.
static java.lang.String JMS_IBM_MQMD_PERSISTENCE
          A constant for the JMS_IBM_MQMD_Persistence property name.
static java.lang.String JMS_IBM_MQMD_REPLYTOQ
          A constant for the JMS_IBM_MQMD_ReplyToQ property name.
static java.lang.String JMS_IBM_MQMD_REPLYTOQMGR
          A constant for the JMS_IBM_MQMD_ReplyToQMgr property name.
static java.lang.String JMSX_APPID
          A constant for the JMSXAppID property name.
static java.lang.String JMSX_DELIVERY_COUNT
          A constant for the JMSXDeliveryCount property name.
static java.lang.String JMSX_GROUPID
          A constant for the JMSXGroupID property name.
static java.lang.String JMSX_GROUPSEQ
          A constant for the JMSXGroupSeq property name.
static java.lang.String JMSX_USERID
          A constant for the JMSXUserID property name.
static java.lang.String LAST_MSG_IN_GROUP_PROPERTY
          Name of the Last_Msg_In_Group property.
static java.lang.String MAPPING_AS_SIB_DESTINATION
          Used to indicate that JMS messages should be sent with the default reliability configured on the SIB destination.
static java.lang.String MAPPING_ASSURED_PERSISTENT
          Used to indicate that JMS messages should be sent with Reliability.ASSURED_PERSISTENT.
static java.lang.String MAPPING_BEST_EFFORT_NONPERSISTENT
          Used to indicate that JMS messages should be sent with Reliability.BEST_EFFORT_NONPERSISTENT.
static java.lang.String MAPPING_EXPRESS_NONPERSISTENT
          Used to indicate that JMS messages should be sent with Reliability.EXPRESS_NONPERSISTENT.
static java.lang.String MAPPING_NONE
          Used to indicate that JMS messages should be sent with the default reliability configured on the SIB destination.
static java.lang.String MAPPING_RELIABLE_NONPERSISTENT
          Used to indicate that JMS messages should be sent with Reliability.RELIABLE_NONPERSISTENT.
static java.lang.String MAPPING_RELIABLE_PERSISTENT
          Used to indicate that JMS messages should be sent with Reliability.RELIABLE_PERSISTENT.
static long MAX_TIME_TO_LIVE
          The maximum permitted value for timeToLive.
static java.lang.String MIGHT_MODIFY_PAYLOAD
          Constant - one of the possible values of the ConnectionFactory properties: producerDoesNotModifyPayloadAfterSet consumerDoesNotModifyPayloadAfterGet
static int MQFB_APPL_CANNOT_BE_STARTED
          Value used with FEEDBACK_PROPERTY.
static int MQFB_APPL_FIRST
          Value used with FEEDBACK_PROPERTY to indicate the first value in the range reserved for application use.
static int MQFB_APPL_LAST
          Value used with FEEDBACK_PROPERTY to indicate the last value in the range reserved for application use.
static int MQFB_APPL_TYPE_ERROR
          Value used with FEEDBACK_PROPERTY.
static int MQFB_CHANNEL_COMPLETED
          Value used with FEEDBACK_PROPERTY.
static int MQFB_CHANNEL_FAIL
          Value used with FEEDBACK_PROPERTY.
static int MQFB_CHANNEL_FAIL_RETRY
          Value used with FEEDBACK_PROPERTY.
static int MQFB_COA
          Value used with FEEDBACK_PROPERTY to indicate that a message arrived at its destination.
static int MQFB_COD
          Value used with FEEDBACK_PROPERTY to indicate that a message was delivered to an application.
static int MQFB_EXPIRATION
          Value used with FEEDBACK_PROPERTY to indicate that a message expired.
static int MQFB_NAN
          Value used with FEEDBACK_PROPERTY to indicate an application specific negative acknowledge report.
static int MQFB_NONE
          Value used with FEEDBACK_PROPERTY to indicate no feedback.
static int MQFB_PAN
          Value used with FEEDBACK_PROPERTY to indicate an application specific positive acknowledge report.
static int MQFB_QUIT
          Value used with FEEDBACK_PROPERTY to request the application to finish.
static int MQFB_STOPPED_BY_MSG_EXIT
          Value used with FEEDBACK_PROPERTY.
static int MQFB_SYSTEM_FIRST
          Value used with FEEDBACK_PROPERTY to indicate the first value in the range reserved for system use.
static int MQFB_SYSTEM_LAST
          Value used with FEEDBACK_PROPERTY to indicate the last value in the range reserved for system use.
static int MQFB_TM_ERROR
          Value used with FEEDBACK_PROPERTY.
static int MQFB_XMIT_Q_MSG_ERROR
          Value used with FEEDBACK_PROPERTY.
static int MQMT_APPL_FIRST
          Value used with MSG_TYPE_PROPERTY to indicate the first value in the range reserved for applications.
static int MQMT_APPL_LAST
          Value used with MSG_TYPE_PROPERTY to indicate the last value in the range reserved for applications.
static int MQMT_DATAGRAM
          Value used with MSG_TYPE_PROPERTY to indicate a datagram message.
static int MQMT_REPORT
          Value used with MSG_TYPE_PROPERTY to indicate a report message.
static int MQMT_REQUEST
          Value used with MSG_TYPE_PROPERTY to indicate a request message.
static int MQRO_COA
          Value used with REPORT_COA_PROPERTY to indicate that a report message without data is required.
static int MQRO_COA_WITH_DATA
          Value used with REPORT_COA_PROPERTY to indicate that a report message with partial data is required.
static int MQRO_COA_WITH_FULL_DATA
          Value used with REPORT_COA_PROPERTY to indicate that a report message with full data is required.
static int MQRO_COD
          Value used with REPORT_COD_PROPERTY to indicate that a report message without data is required.
static int MQRO_COD_WITH_DATA
          Value used with REPORT_COD_PROPERTY to indicate that a report message with partial data is required.
static int MQRO_COD_WITH_FULL_DATA
          Value used with REPORT_COD_PROPERTY to indicate that a report message with full data is required.
static int MQRO_COPY_MSG_ID_TO_CORREL_ID
          Value used with REPORT_CORRELID_PROPERTY to indicate that the messageID of the request message should be copied to the correlationID of the report.
static int MQRO_DEAD_LETTER_Q
          Value used with the REPORT_DISCARD_PROPERTY to indicate that the request message should be placed on an exception destination if it can not be delivered to its original destination.
static int MQRO_DISCARD_MSG
          Value used with the REPORT_DISCARD_PROPERTY to indicate that the request message should be discarded if it can not be delivered to its original destination.
static int MQRO_EXCEPTION
          Value used with REPORT_EXCEPTION_PROPERTY to indicate that a report message without data is required.
static int MQRO_EXCEPTION_WITH_DATA
          Value used with REPORT_EXCEPTION_PROPERTY to indicate that a report message with partial data is required.
static int MQRO_EXCEPTION_WITH_FULL_DATA
          Value used with REPORT_EXCEPTION_PROPERTY to indicate that a report message with full data is required.
static int MQRO_EXPIRATION
          Value used with REPORT_EXPIRATION_PROPERTY to indicate that a report message without data is required.
static int MQRO_EXPIRATION_WITH_DATA
          Value used with REPORT_EXPIRATION_PROPERTY to indicate that a report message with partial data is required.
static int MQRO_EXPIRATION_WITH_FULL_DATA
          Value used with REPORT_EXPIRATION_PROPERTY to indicate that a report message with full data is required.
static int MQRO_NAN
          Value used with the REPORT_NAN_PROPERTY to request an application specific negative acknowledge report.
static int MQRO_NEW_MSG_ID
          Value used with the REPORT_MSGID_PROPERTY to indicate that a new messageID should be generated for the report message.
static int MQRO_NONE
          Value used with the REPORT properties to indicate that no options are required.
static int MQRO_PAN
          Value used with the REPORT_PAN_PROPERTY to request an application specific positive acknowledge report.
static int MQRO_PASS_CORREL_ID
          Value used with REPORT_CORRELID_PROPERTY to indicate that the correlationID of the request message should be copied to the correlationID of the report.
static int MQRO_PASS_MSG_ID
          Value used with the REPORT_MSGID_PROPERTY to indicate that the messageID of the request message should be passed as the messageID of the report message.
static java.lang.String MSG_BUNDLE_EXT
          This constant defines the NLS message file used for messages which occur in response to the public JMS specification.
static java.lang.String MSG_BUNDLE_INT
          This constant defines the NLS message file used for messages which occur in response to provider specific events.
static java.lang.String MSG_GROUP_EXT
          This constant defines the message group used when tracing methods which form part of the public JMS specification.
static java.lang.String MSG_GROUP_INT
          This constant defines the message group used when tracing methods which are implementation internal or defined on the provider specific extensions to the JMS objects.
static java.lang.String MSG_TYPE_PROPERTY
          Name of the message type property.
static java.lang.String MULTICAST_INTERFACE_NONE
          Value for multicastInterface None mode.
static java.lang.String OFF
          Common constant to ensure consistency between multiple "On" value properties.
static java.lang.String ON
          Common constant to ensure consistency between multiple "On" value properties.
static java.lang.String PRODUCER_BIND_OFF
          Constant used to indicate that a MessageProducer using a JMS Queue with this property set should not bind to a single queue point, but instead allow different messages to be sent to different queue points.
static java.lang.String PRODUCER_BIND_ON
          Constant used to indicate that a MessageProducer using a JMS Queue with this property set should bind to a single queue point and send all messages to it.
static java.lang.String PRODUCER_PREFER_LOCAL_OFF
          Constant used to indicate that a MessageProducer using a JMS Queue with this property does not have a preference for local queue points of the destination.
static java.lang.String PRODUCER_PREFER_LOCAL_ON
          Constant used to indicate that a MessageProducer using a JMS Queue with this property set should prefer a locally connected queue point of the queue destination over any other queue points.
static java.lang.String PUT_APPL_TYPE_PROPERTY
          Name of the PutApplType property.
static java.lang.String PUT_DATE_PROPERTY
          Name of the PutDate property.
static java.lang.String PUT_TIME_PROPERTY
          Name of the PutTime property.
static java.lang.String READ_AHEAD_AS_CONNECTION
          Default value for the ReadAhead property of a JmsDestination which defines that the consumers created using this Destination should inherit their readAhead behaviour from the value in effect on the ConnectionFactory at the time that the Connection was created.
static java.lang.String READ_AHEAD_DEFAULT
          Default value for the ReadAhead property of a JmsConnectionFactory.
static java.lang.String READ_AHEAD_OFF
          Value for the ReadAhead property of a JmsConnectionFactory and JmsDestination which defines that all consumers created using this object will have ReadAhead turned off.
static java.lang.String READ_AHEAD_ON
          Value for the ReadAhead property of a JmsConnectionFactory and JmsDestination which defines that all consumers created using this object will have ReadAhead turned on.
static java.lang.String REPORT_COA_PROPERTY
          Name of the Report_COA property.
static java.lang.String REPORT_COD_PROPERTY
          Name of the Report_COD property.
static java.lang.String REPORT_CORRELID_PROPERTY
          Name of the Report_Pass_Correl_ID property.
static java.lang.String REPORT_DISCARD_PROPERTY
          Name of the Report_Discard_Msg property.
static java.lang.String REPORT_EXCEPTION_PROPERTY
          Name of the Report_Exception property.
static java.lang.String REPORT_EXPIRATION_PROPERTY
          Name of the Report_Expiration property.
static java.lang.String REPORT_MSGID_PROPERTY
          Name of the Report_Pass_Msg_ID property.
static java.lang.String REPORT_NAN_PROPERTY
          Name of the Report_NAN property.
static java.lang.String REPORT_PAN_PROPERTY
          Name of the Report_PAN property.
static java.lang.String SCOPE_TO_LOCAL_QP_OFF
          Constant used with a JMS queue to indicate that the SIB queue destination identified by the JMS Queue is not scoped to a single queue point - the system will choose which of the available queue points of the SIB destination to use, which may include work load balancing of requests across different queue points.
static java.lang.String SCOPE_TO_LOCAL_QP_ON
          Constant used with a JMS queue to indicate that the SIB queue destination identified by the JMSQueue is dynamically scoped to a single queue point if one exists on the messaging engine that the application is connected to.
static java.lang.String SHARED_DSUBS_ALWAYS
          Constant that can be used as a parameter for the shareDurableSubscriptions property of a JmsConnectionFactory object.
static java.lang.String SHARED_DSUBS_IN_CLUSTER
          Constant that represents the default value for the shareDurableSubscriptions property of a JmsConnectionFactory object.
static java.lang.String SHARED_DSUBS_NEVER
          Constant that can be used as a parameter for the shareDurableSubscriptions property of a JmsConnectionFactory object.
static java.lang.String SUBSCRIPTION_PROTOCOL_MULTICAST
          Value for Multicast mode.
static java.lang.String SUBSCRIPTION_PROTOCOL_UNICAST
          Value for Unicast mode.
static java.lang.String SUBSCRIPTION_PROTOCOL_UNICAST_AND_MULTICAST
          Value for UnicastAndMulticast mode.
static java.lang.String SYSTEM_MESSAGEID_PROPERTY
          Name of the system messageID property.
static java.lang.String TARGET_SIGNIFICANCE_PREFERRED
          Value for the targetSignificance property of a JmsConnectionFactory that indicates that it is preferred that the selected messaging engine be in the targetGroup.
static java.lang.String TARGET_SIGNIFICANCE_REQUIRED
          Value for the targetSignificance property of a JmsConnectionFactory that indicates that selected messaging engine must be in the targetGroup.
static java.lang.String TARGET_TYPE_BUSMEMBER
          Value for the targetType property of a JmsConnectionFactory that indicates that the information specified in the targetGroup is the name of a bus.
static java.lang.String TARGET_TYPE_CUSTOM
          Value for the targetType property of a JmsConnectionFactory that indicates that the information specified in the targetGroup is a user specified group name.
static java.lang.String TARGET_TYPE_ME
          Value for the targetType property of a JmsConnectionFactory that indicates that the information specified in the targetGroup is the name of a messaging engine.
static java.lang.String TOG_ARM_CORRELATOR
          Constant for accessing the The Open Group (TOG) ARM correlator property.
static java.lang.String WILL_NOT_MODIFY_PAYLOAD
          Constant - one of the possible values of the ConnectionFactory properties: producerDoesNotModifyPayloadAfterSet consumerDoesNotModifyPayloadAfterGet
 

Field Detail

MSG_GROUP_EXT

static final java.lang.String MSG_GROUP_EXT
This constant defines the message group used when tracing methods which form part of the public JMS specification.

There is a separate message group for methods which are implementation internal or defined on the provider specific extensions to the JMS objects.

This is not intended for use by customer applications.

See Also:
MSG_GROUP_INT, MSG_BUNDLE_EXT

MSG_BUNDLE_EXT

static final java.lang.String MSG_BUNDLE_EXT
This constant defines the NLS message file used for messages which occur in response to the public JMS specification.

This is not intended for use by customer applications.

See Also:
MSG_GROUP_EXT, MSG_GROUP_INT, Constant Field Values

MSG_GROUP_INT

static final java.lang.String MSG_GROUP_INT
This constant defines the message group used when tracing methods which are implementation internal or defined on the provider specific extensions to the JMS objects.

This is not intended for use by customer applications.

See Also:
MSG_BUNDLE_INT

MSG_BUNDLE_INT

static final java.lang.String MSG_BUNDLE_INT
This constant defines the NLS message file used for messages which occur in response to provider specific events.

This is not intended for use by customer applications.

See Also:
MSG_GROUP_INT, MSG_GROUP_EXT, Constant Field Values

EXCEPTION_THREADPOOL_NAME_INT

static final java.lang.String EXCEPTION_THREADPOOL_NAME_INT
This constant defines the name of the thread pool created to dispatch JMS Exceptions to applications.

This is not intended for use by customer applications.

See Also:
Constant Field Values

EXCEPTION_MAXTHREADS_NAME_INT

static final java.lang.String EXCEPTION_MAXTHREADS_NAME_INT
This constant defines name of a tuning parameter.
This tuning parameter specifies how many threads may be active concurrently, invoking application provided JMS exception listeners on different connections. A maximum of one thread is ever active per connection.

This is not intended for use by customer applications.

See Also:
Constant Field Values

EXCEPTION_MAXTHREADS_DEFAULT_INT

static final java.lang.String EXCEPTION_MAXTHREADS_DEFAULT_INT
This constant defines the default number of threads which may be active concurrently, invoking JMS exception listeners.

This is not intended for use by customer applications.

See Also:
EXCEPTION_MAXTHREADS_NAME_INT, Constant Field Values

CONNFACTORY_FACTORY_CLASS

static final java.lang.String CONNFACTORY_FACTORY_CLASS
This constant contains the name of the class which implements the JmsFactoryFactory interface. This constant is used to dynamically instantiate the implementation class in order to provide separation between component interfaces and implementation. This is not intended for use by customer applications.

See Also:
JmsFactoryFactory, Constant Field Values

MAPPING_BEST_EFFORT_NONPERSISTENT

static final java.lang.String MAPPING_BEST_EFFORT_NONPERSISTENT
Used to indicate that JMS messages should be sent with Reliability.BEST_EFFORT_NONPERSISTENT.

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_EXPRESS_NONPERSISTENT, MAPPING_RELIABLE_NONPERSISTENT, MAPPING_RELIABLE_PERSISTENT, MAPPING_ASSURED_PERSISTENT, MAPPING_AS_SIB_DESTINATION

MAPPING_EXPRESS_NONPERSISTENT

static final java.lang.String MAPPING_EXPRESS_NONPERSISTENT
Used to indicate that JMS messages should be sent with Reliability.EXPRESS_NONPERSISTENT.

This is the default value for the nonPersistentMapping property.

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_BEST_EFFORT_NONPERSISTENT, MAPPING_RELIABLE_NONPERSISTENT, MAPPING_RELIABLE_PERSISTENT, MAPPING_ASSURED_PERSISTENT, MAPPING_AS_SIB_DESTINATION

MAPPING_RELIABLE_NONPERSISTENT

static final java.lang.String MAPPING_RELIABLE_NONPERSISTENT
Used to indicate that JMS messages should be sent with Reliability.RELIABLE_NONPERSISTENT.

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_BEST_EFFORT_NONPERSISTENT, MAPPING_EXPRESS_NONPERSISTENT, MAPPING_ASSURED_PERSISTENT, MAPPING_AS_SIB_DESTINATION

MAPPING_RELIABLE_PERSISTENT

static final java.lang.String MAPPING_RELIABLE_PERSISTENT
Used to indicate that JMS messages should be sent with Reliability.RELIABLE_PERSISTENT.

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_BEST_EFFORT_NONPERSISTENT, MAPPING_EXPRESS_NONPERSISTENT, MAPPING_RELIABLE_NONPERSISTENT, MAPPING_ASSURED_PERSISTENT, MAPPING_AS_SIB_DESTINATION

MAPPING_ASSURED_PERSISTENT

static final java.lang.String MAPPING_ASSURED_PERSISTENT
Used to indicate that JMS messages should be sent with Reliability.ASSURED_PERSISTENT.

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_BEST_EFFORT_NONPERSISTENT, MAPPING_EXPRESS_NONPERSISTENT, MAPPING_RELIABLE_NONPERSISTENT, MAPPING_RELIABLE_PERSISTENT, MAPPING_AS_SIB_DESTINATION

MAPPING_AS_SIB_DESTINATION

static final java.lang.String MAPPING_AS_SIB_DESTINATION
Used to indicate that JMS messages should be sent with the default reliability configured on the SIB destination. This is a synonym for MAPPING_NONE.

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_BEST_EFFORT_NONPERSISTENT, MAPPING_EXPRESS_NONPERSISTENT, MAPPING_RELIABLE_NONPERSISTENT, MAPPING_RELIABLE_PERSISTENT, MAPPING_ASSURED_PERSISTENT, Constant Field Values

MAPPING_NONE

static final java.lang.String MAPPING_NONE
Used to indicate that JMS messages should be sent with the default reliability configured on the SIB destination. This is a synonym for MAPPING_AS_SIB_DESTINATION

See Also:
JmsConnectionFactory.setNonPersistentMapping(String), JmsConnectionFactory.setPersistentMapping(String), MAPPING_BEST_EFFORT_NONPERSISTENT, MAPPING_EXPRESS_NONPERSISTENT, MAPPING_RELIABLE_NONPERSISTENT, MAPPING_RELIABLE_PERSISTENT, MAPPING_ASSURED_PERSISTENT

CONNECTION_PROXIMITY_SERVER

static final java.lang.String CONNECTION_PROXIMITY_SERVER
Value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine in the same server process.

See Also:
JmsConnectionFactory.setConnectionProximity(String), CONNECTION_PROXIMITY_HOST, CONNECTION_PROXIMITY_BUS, CONNECTION_PROXIMITY_CLUSTER, Constant Field Values

CONNECTION_PROXIMITY_HOST

static final java.lang.String CONNECTION_PROXIMITY_HOST
Value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine on the same host as the client application.

See Also:
JmsConnectionFactory.setConnectionProximity(String), CONNECTION_PROXIMITY_SERVER, CONNECTION_PROXIMITY_BUS, CONNECTION_PROXIMITY_CLUSTER, Constant Field Values

CONNECTION_PROXIMITY_BUS

static final java.lang.String CONNECTION_PROXIMITY_BUS
Default value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine in the specified bus.

See Also:
JmsConnectionFactory.setConnectionProximity(String), CONNECTION_PROXIMITY_SERVER, CONNECTION_PROXIMITY_HOST, CONNECTION_PROXIMITY_CLUSTER, Constant Field Values

CONNECTION_PROXIMITY_CLUSTER

static final java.lang.String CONNECTION_PROXIMITY_CLUSTER
Value for the connectionProximity property of a JmsConnectionFactory that indicates that the application wishes to connect to any messaging engine on the same cluster as the client application.

See Also:
JmsConnectionFactory.setConnectionProximity(String), CONNECTION_PROXIMITY_SERVER, CONNECTION_PROXIMITY_BUS, CONNECTION_PROXIMITY_HOST, Constant Field Values

TARGET_TYPE_BUSMEMBER

static final java.lang.String TARGET_TYPE_BUSMEMBER
Value for the targetType property of a JmsConnectionFactory that indicates that the information specified in the targetGroup is the name of a bus.

The messaging engine chosen to connect to should be a member of this bus.

See Also:
JmsConnectionFactory.setTargetType(String), TARGET_TYPE_CUSTOM, TARGET_TYPE_ME, Constant Field Values

TARGET_TYPE_CUSTOM

static final java.lang.String TARGET_TYPE_CUSTOM
Value for the targetType property of a JmsConnectionFactory that indicates that the information specified in the targetGroup is a user specified group name.

The messaging engine chosen to connect to should be a member of this user specified group.

See Also:
JmsConnectionFactory.setTargetType(String), TARGET_TYPE_BUSMEMBER, TARGET_TYPE_ME, Constant Field Values

TARGET_TYPE_ME

static final java.lang.String TARGET_TYPE_ME
Value for the targetType property of a JmsConnectionFactory that indicates that the information specified in the targetGroup is the name of a messaging engine.

See Also:
JmsConnectionFactory.setTargetType(String), TARGET_TYPE_BUSMEMBER, TARGET_TYPE_CUSTOM, Constant Field Values

TARGET_SIGNIFICANCE_REQUIRED

static final java.lang.String TARGET_SIGNIFICANCE_REQUIRED
Value for the targetSignificance property of a JmsConnectionFactory that indicates that selected messaging engine must be in the targetGroup.

See Also:
JmsConnectionFactory.setTargetSignificance(String), TARGET_SIGNIFICANCE_PREFERRED, Constant Field Values

TARGET_SIGNIFICANCE_PREFERRED

static final java.lang.String TARGET_SIGNIFICANCE_PREFERRED
Value for the targetSignificance property of a JmsConnectionFactory that indicates that it is preferred that the selected messaging engine be in the targetGroup.

See Also:
JmsConnectionFactory.setTargetSignificance(String), TARGET_SIGNIFICANCE_REQUIRED, Constant Field Values

SUBSCRIPTION_PROTOCOL_UNICAST

static final java.lang.String SUBSCRIPTION_PROTOCOL_UNICAST
Value for Unicast mode. Unicast protocol is used for subscriptions.

See Also:
Constant Field Values

SUBSCRIPTION_PROTOCOL_MULTICAST

static final java.lang.String SUBSCRIPTION_PROTOCOL_MULTICAST
Value for Multicast mode. Multicast protocol is used for subscriptions.

See Also:
Constant Field Values

SUBSCRIPTION_PROTOCOL_UNICAST_AND_MULTICAST

static final java.lang.String SUBSCRIPTION_PROTOCOL_UNICAST_AND_MULTICAST
Value for UnicastAndMulticast mode. Means both unicast and multicast protocols may be used for subscriptions.

See Also:
Constant Field Values

MULTICAST_INTERFACE_NONE

static final java.lang.String MULTICAST_INTERFACE_NONE
Value for multicastInterface None mode. Means use the default local IP address.

See Also:
Constant Field Values

READ_AHEAD_DEFAULT

static final java.lang.String READ_AHEAD_DEFAULT
Default value for the ReadAhead property of a JmsConnectionFactory.

The behaviour controlled by ReadAhead is described in the documentation for JmsConnectionFactory.setReadAhead(String).

The defaults applied by specifying this value are;

Situation ReadAhead
Consumers attached to a queue type destination (point-to-point) false
Non-durable consumers of a topic type destination (publish and subscribe) true
Durable subscribers in a non-cloned environment true
Durable subscribers in a cloned environment false

Deviation from this default behaviour should be carefully considered.

See Also:
JmsConnectionFactory.setReadAhead(String), READ_AHEAD_ON, READ_AHEAD_OFF, Constant Field Values

READ_AHEAD_ON

static final java.lang.String READ_AHEAD_ON
Value for the ReadAhead property of a JmsConnectionFactory and JmsDestination which defines that all consumers created using this object will have ReadAhead turned on.

Please see JmsConnectionFactory.setReadAhead(String) for information on the effect of the ReadAhead property.

Note that specifying this value on a JmsDestination object will override the value specified on the ConnectionFactory.

See Also:
JmsConnectionFactory.setReadAhead(String), JmsDestination.setReadAhead(String), READ_AHEAD_DEFAULT, READ_AHEAD_OFF, Constant Field Values

READ_AHEAD_OFF

static final java.lang.String READ_AHEAD_OFF
Value for the ReadAhead property of a JmsConnectionFactory and JmsDestination which defines that all consumers created using this object will have ReadAhead turned off.

Please see JmsConnectionFactory.setReadAhead(String) for information on the effect of the ReadAhead property.

Note that specifying this value on a JmsDestination object will override the value specified on the ConnectionFactory.

See Also:
JmsConnectionFactory.setReadAhead(String), JmsDestination.setReadAhead(String), READ_AHEAD_DEFAULT, READ_AHEAD_ON, Constant Field Values

READ_AHEAD_AS_CONNECTION

static final java.lang.String READ_AHEAD_AS_CONNECTION
Default value for the ReadAhead property of a JmsDestination which defines that the consumers created using this Destination should inherit their readAhead behaviour from the value in effect on the ConnectionFactory at the time that the Connection was created.

Please see JmsConnectionFactory.setReadAhead(String) for information on the effect of the ReadAhead property.

See Also:
JmsDestination.setReadAhead(String), READ_AHEAD_ON, READ_AHEAD_OFF, Constant Field Values

SHARED_DSUBS_IN_CLUSTER

static final java.lang.String SHARED_DSUBS_IN_CLUSTER
Constant that represents the default value for the shareDurableSubscriptions property of a JmsConnectionFactory object.

Applications running in a non-cloned environment will be subject to the JMS specification requirement that there be at most one active consumer for a durable subscription. Non-cloned environments include both non-cloned application servers and remote client (J2EE AppClient) cases.

Applications running in a cloned application server will be automatically detected, and access to any durable subscriptions will be shared across any applications supplying the same clientID and subscription name (ie the clones of the application).

See Also:
JmsConnectionFactory.setShareDurableSubscriptions(String), SHARED_DSUBS_ALWAYS, Constant Field Values

SHARED_DSUBS_ALWAYS

static final java.lang.String SHARED_DSUBS_ALWAYS
Constant that can be used as a parameter for the shareDurableSubscriptions property of a JmsConnectionFactory object.

Applications using this value will always connect to durable subscriptions in a non-exclusive way regardless of the environment in which they are exceuted. This allows multiple active consumers for the durable subscription.

Note that use of this property should be carefully considered since the default SHARED_DSUBS_IN_CLUSTER option provides sensible behaviour in most environments.

See Also:
JmsConnectionFactory.setShareDurableSubscriptions(String), SHARED_DSUBS_IN_CLUSTER, SHARED_DSUBS_NEVER, Constant Field Values

SHARED_DSUBS_NEVER

static final java.lang.String SHARED_DSUBS_NEVER
Constant that can be used as a parameter for the shareDurableSubscriptions property of a JmsConnectionFactory object.

Applications using this value will never connect to durable subscriptions in a non-exclusive way regardless of the environment in which they are exceuted. This ensures that at most one consumer instance may be active for a durable subscription at any time.

Note that use of this property should be carefully considered since the default SHARED_DSUBS_IN_CLUSTER option provides sensible behaviour in most environments. For example if there are multiple instances of an EJB running with this option then only one of them will be able to access the durable subscription.

Applications wishing to have independent access to durable subscriptions from many cloned application instances may be better served by deploying a ConnectionFactory object at the server scope with different clientID than share a single ConnectionFactory object with this option enabled.

See Also:
JmsConnectionFactory.setShareDurableSubscriptions(String), SHARED_DSUBS_IN_CLUSTER, SHARED_DSUBS_ALWAYS, Constant Field Values

ON

static final java.lang.String ON
Common constant to ensure consistency between multiple "On" value properties.

See Also:
Constant Field Values

OFF

static final java.lang.String OFF
Common constant to ensure consistency between multiple "On" value properties.

See Also:
Constant Field Values

SCOPE_TO_LOCAL_QP_ON

static final java.lang.String SCOPE_TO_LOCAL_QP_ON
Constant used with a JMS queue to indicate that the SIB queue destination identified by the JMSQueue is dynamically scoped to a single queue point if one exists on the messaging engine that the application is connected to.

Since:
V7.0
See Also:
JmsQueue.setScopeToLocalQP(String), Constant Field Values

SCOPE_TO_LOCAL_QP_OFF

static final java.lang.String SCOPE_TO_LOCAL_QP_OFF
Constant used with a JMS queue to indicate that the SIB queue destination identified by the JMS Queue is not scoped to a single queue point - the system will choose which of the available queue points of the SIB destination to use, which may include work load balancing of requests across different queue points. This is the default value for this property.

Since:
V7.0
See Also:
JmsQueue.setScopeToLocalQP(String), Constant Field Values

PRODUCER_PREFER_LOCAL_ON

static final java.lang.String PRODUCER_PREFER_LOCAL_ON
Constant used to indicate that a MessageProducer using a JMS Queue with this property set should prefer a locally connected queue point of the queue destination over any other queue points. This is the default value for this property.

Since:
V7.0
See Also:
JmsQueue.setProducerPreferLocal(String), Constant Field Values

PRODUCER_PREFER_LOCAL_OFF

static final java.lang.String PRODUCER_PREFER_LOCAL_OFF
Constant used to indicate that a MessageProducer using a JMS Queue with this property does not have a preference for local queue points of the destination.

Since:
V7.0
See Also:
JmsQueue.setProducerPreferLocal(String), Constant Field Values

PRODUCER_BIND_ON

static final java.lang.String PRODUCER_BIND_ON
Constant used to indicate that a MessageProducer using a JMS Queue with this property set should bind to a single queue point and send all messages to it.

Since:
V7.0
See Also:
JmsQueue.setProducerBind(String), Constant Field Values

PRODUCER_BIND_OFF

static final java.lang.String PRODUCER_BIND_OFF
Constant used to indicate that a MessageProducer using a JMS Queue with this property set should not bind to a single queue point, but instead allow different messages to be sent to different queue points. This is the default for this property.

Since:
V7.0
See Also:
JmsQueue.setProducerBind(String), Constant Field Values

GATHER_MESSAGES_ON

static final java.lang.String GATHER_MESSAGES_ON
Constant used to indicate that messages on all queue points of the SIB destination referenced by the JMS Queue are visible to MessageConsumers and QueueBrowsers.

Since:
V7.0
See Also:
JmsQueue.setGatherMessages(String), Constant Field Values

GATHER_MESSAGES_OFF

static final java.lang.String GATHER_MESSAGES_OFF
Constant used to indicate that only messages on the local queue point (hosted by the messaging engine to which the application is connected) of the SIB destination are visible to MessageConsumers and QueueBrowsers. This is the default for this property.

Since:
V7.0
See Also:
JmsQueue.setGatherMessages(String), Constant Field Values

FORMAT_PROPERTY

static final java.lang.String FORMAT_PROPERTY
Name of the Format property. For use with MQ Interoperability, this property reflects the MQMD.format field of incoming messages and can be used to provide a value for outgoing messages.

See Also:
Constant Field Values

MSG_TYPE_PROPERTY

static final java.lang.String MSG_TYPE_PROPERTY
Name of the message type property. For use with MQ interoperability, this property reflects the MQMD.MsgType field of incoming messages and can be used to provide a value for outgoing messages.

See Also:
Constant Field Values

FEEDBACK_PROPERTY

static final java.lang.String FEEDBACK_PROPERTY
Name of the feedback property. With MQ interoperability, this maps to the MQMD.Feedback field. Natively generated report messages also use this field to indicate the reason the report was generated.

See Also:
Constant Field Values

PUT_APPL_TYPE_PROPERTY

static final java.lang.String PUT_APPL_TYPE_PROPERTY
Name of the PutApplType property. With MQ interoperability, this reflects the MQMD.PutApplType field for incoming messages. It is ignored on sent messages.

See Also:
Constant Field Values

REPORT_EXCEPTION_PROPERTY

static final java.lang.String REPORT_EXCEPTION_PROPERTY
Name of the Report_Exception property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages. It is also used to control the generation of native report messages.

See Also:
Constant Field Values

REPORT_EXPIRATION_PROPERTY

static final java.lang.String REPORT_EXPIRATION_PROPERTY
Name of the Report_Expiration property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages. It is also used to control the generation of native report messages.

See Also:
Constant Field Values

REPORT_COA_PROPERTY

static final java.lang.String REPORT_COA_PROPERTY
Name of the Report_COA property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages. It is also used to control the generation of native report messages.

See Also:
Constant Field Values

REPORT_COD_PROPERTY

static final java.lang.String REPORT_COD_PROPERTY
Name of the Report_COD property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages. It is also used to control the generation of native report messages.

See Also:
Constant Field Values

REPORT_PAN_PROPERTY

static final java.lang.String REPORT_PAN_PROPERTY
Name of the Report_PAN property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages. This field is used to indicate desired behaviour of the receiving application, and doesn't impact the behaviour of the messaging transport.

See Also:
Constant Field Values

REPORT_NAN_PROPERTY

static final java.lang.String REPORT_NAN_PROPERTY
Name of the Report_NAN property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages. This field is used to indicate desired behaviour of the receiving application, and doesn't impact the behaviour of the messaging transport.

See Also:
Constant Field Values

REPORT_MSGID_PROPERTY

static final java.lang.String REPORT_MSGID_PROPERTY
Name of the Report_Pass_Msg_ID property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages.

See Also:
Constant Field Values

REPORT_CORRELID_PROPERTY

static final java.lang.String REPORT_CORRELID_PROPERTY
Name of the Report_Pass_Correl_ID property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages.

See Also:
Constant Field Values

REPORT_DISCARD_PROPERTY

static final java.lang.String REPORT_DISCARD_PROPERTY
Name of the Report_Discard_Msg property. With MQ interoperability, this field reflects the relevent bits of the MQMD.report field on incoming messages, and can be used to influence the value of outgoing messages.

See Also:
Constant Field Values

MQRO_EXCEPTION

static final int MQRO_EXCEPTION
Value used with REPORT_EXCEPTION_PROPERTY to indicate that a report message without data is required.

See Also:
REPORT_EXCEPTION_PROPERTY, MQRO_EXCEPTION_WITH_DATA, MQRO_EXCEPTION_WITH_FULL_DATA, Constant Field Values

MQRO_EXCEPTION_WITH_DATA

static final int MQRO_EXCEPTION_WITH_DATA
Value used with REPORT_EXCEPTION_PROPERTY to indicate that a report message with partial data is required.

See Also:
REPORT_EXCEPTION_PROPERTY, MQRO_EXCEPTION, MQRO_EXCEPTION_WITH_FULL_DATA, Constant Field Values

MQRO_EXCEPTION_WITH_FULL_DATA

static final int MQRO_EXCEPTION_WITH_FULL_DATA
Value used with REPORT_EXCEPTION_PROPERTY to indicate that a report message with full data is required.

See Also:
REPORT_EXCEPTION_PROPERTY, MQRO_EXCEPTION, MQRO_EXCEPTION_WITH_DATA, Constant Field Values

MQRO_EXPIRATION

static final int MQRO_EXPIRATION
Value used with REPORT_EXPIRATION_PROPERTY to indicate that a report message without data is required.

See Also:
REPORT_EXPIRATION_PROPERTY, MQRO_EXPIRATION_WITH_DATA, MQRO_EXPIRATION_WITH_FULL_DATA, Constant Field Values

MQRO_EXPIRATION_WITH_DATA

static final int MQRO_EXPIRATION_WITH_DATA
Value used with REPORT_EXPIRATION_PROPERTY to indicate that a report message with partial data is required.

See Also:
REPORT_EXPIRATION_PROPERTY, MQRO_EXPIRATION, MQRO_EXPIRATION_WITH_FULL_DATA, Constant Field Values

MQRO_EXPIRATION_WITH_FULL_DATA

static final int MQRO_EXPIRATION_WITH_FULL_DATA
Value used with REPORT_EXPIRATION_PROPERTY to indicate that a report message with full data is required.

See Also:
REPORT_EXPIRATION_PROPERTY, MQRO_EXPIRATION, MQRO_EXPIRATION_WITH_DATA, Constant Field Values

MQRO_COA

static final int MQRO_COA
Value used with REPORT_COA_PROPERTY to indicate that a report message without data is required.

See Also:
REPORT_COA_PROPERTY, MQRO_COA_WITH_DATA, MQRO_COA_WITH_FULL_DATA, Constant Field Values

MQRO_COA_WITH_DATA

static final int MQRO_COA_WITH_DATA
Value used with REPORT_COA_PROPERTY to indicate that a report message with partial data is required.

See Also:
REPORT_COA_PROPERTY, MQRO_COA, MQRO_COA_WITH_FULL_DATA, Constant Field Values

MQRO_COA_WITH_FULL_DATA

static final int MQRO_COA_WITH_FULL_DATA
Value used with REPORT_COA_PROPERTY to indicate that a report message with full data is required.

See Also:
REPORT_COA_PROPERTY, MQRO_COA, MQRO_COA_WITH_DATA, Constant Field Values

MQRO_COD

static final int MQRO_COD
Value used with REPORT_COD_PROPERTY to indicate that a report message without data is required.

See Also:
REPORT_COD_PROPERTY, MQRO_COD_WITH_DATA, MQRO_COD_WITH_FULL_DATA, Constant Field Values

MQRO_COD_WITH_DATA

static final int MQRO_COD_WITH_DATA
Value used with REPORT_COD_PROPERTY to indicate that a report message with partial data is required.

See Also:
REPORT_COD_PROPERTY, MQRO_COD, MQRO_COD_WITH_FULL_DATA, Constant Field Values

MQRO_COD_WITH_FULL_DATA

static final int MQRO_COD_WITH_FULL_DATA
Value used with REPORT_COD_PROPERTY to indicate that a report message with full data is required.

See Also:
REPORT_COD_PROPERTY, MQRO_COD, MQRO_COD_WITH_DATA, Constant Field Values

MQRO_COPY_MSG_ID_TO_CORREL_ID

static final int MQRO_COPY_MSG_ID_TO_CORREL_ID
Value used with REPORT_CORRELID_PROPERTY to indicate that the messageID of the request message should be copied to the correlationID of the report.

See Also:
REPORT_CORRELID_PROPERTY, MQRO_PASS_CORREL_ID, Constant Field Values

MQRO_PASS_CORREL_ID

static final int MQRO_PASS_CORREL_ID
Value used with REPORT_CORRELID_PROPERTY to indicate that the correlationID of the request message should be copied to the correlationID of the report.

See Also:
REPORT_CORRELID_PROPERTY, MQRO_COPY_MSG_ID_TO_CORREL_ID, Constant Field Values

MQRO_NEW_MSG_ID

static final int MQRO_NEW_MSG_ID
Value used with the REPORT_MSGID_PROPERTY to indicate that a new messageID should be generated for the report message.

See Also:
REPORT_MSGID_PROPERTY, MQRO_PASS_MSG_ID, Constant Field Values

MQRO_PASS_MSG_ID

static final int MQRO_PASS_MSG_ID
Value used with the REPORT_MSGID_PROPERTY to indicate that the messageID of the request message should be passed as the messageID of the report message.

See Also:
REPORT_MSGID_PROPERTY, MQRO_NEW_MSG_ID, Constant Field Values

MQRO_DEAD_LETTER_Q

static final int MQRO_DEAD_LETTER_Q
Value used with the REPORT_DISCARD_PROPERTY to indicate that the request message should be placed on an exception destination if it can not be delivered to its original destination.

See Also:
REPORT_DISCARD_PROPERTY, MQRO_DISCARD_MSG, Constant Field Values

MQRO_DISCARD_MSG

static final int MQRO_DISCARD_MSG
Value used with the REPORT_DISCARD_PROPERTY to indicate that the request message should be discarded if it can not be delivered to its original destination.

See Also:
REPORT_DISCARD_PROPERTY, MQRO_DISCARD_MSG, Constant Field Values

MQRO_NONE

static final int MQRO_NONE
Value used with the REPORT properties to indicate that no options are required. Equivalent to not setting the property.

See Also:
Constant Field Values

MQRO_NAN

static final int MQRO_NAN
Value used with the REPORT_NAN_PROPERTY to request an application specific negative acknowledge report.

See Also:
REPORT_NAN_PROPERTY, MQRO_PAN, Constant Field Values

MQRO_PAN

static final int MQRO_PAN
Value used with the REPORT_PAN_PROPERTY to request an application specific positive acknowledge report.

See Also:
REPORT_PAN_PROPERTY, MQRO_NAN, Constant Field Values

MQFB_NONE

static final int MQFB_NONE
Value used with FEEDBACK_PROPERTY to indicate no feedback.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_SYSTEM_FIRST

static final int MQFB_SYSTEM_FIRST
Value used with FEEDBACK_PROPERTY to indicate the first value in the range reserved for system use.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_QUIT

static final int MQFB_QUIT
Value used with FEEDBACK_PROPERTY to request the application to finish.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_EXPIRATION

static final int MQFB_EXPIRATION
Value used with FEEDBACK_PROPERTY to indicate that a message expired.

See Also:
FEEDBACK_PROPERTY, REPORT_EXPIRATION_PROPERTY, Constant Field Values

MQFB_COA

static final int MQFB_COA
Value used with FEEDBACK_PROPERTY to indicate that a message arrived at its destination.

See Also:
FEEDBACK_PROPERTY, REPORT_COA_PROPERTY, Constant Field Values

MQFB_COD

static final int MQFB_COD
Value used with FEEDBACK_PROPERTY to indicate that a message was delivered to an application.

See Also:
FEEDBACK_PROPERTY, REPORT_COD_PROPERTY, Constant Field Values

MQFB_CHANNEL_COMPLETED

static final int MQFB_CHANNEL_COMPLETED
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_CHANNEL_FAIL_RETRY

static final int MQFB_CHANNEL_FAIL_RETRY
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_CHANNEL_FAIL

static final int MQFB_CHANNEL_FAIL
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_APPL_CANNOT_BE_STARTED

static final int MQFB_APPL_CANNOT_BE_STARTED
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_TM_ERROR

static final int MQFB_TM_ERROR
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_APPL_TYPE_ERROR

static final int MQFB_APPL_TYPE_ERROR
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_STOPPED_BY_MSG_EXIT

static final int MQFB_STOPPED_BY_MSG_EXIT
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_XMIT_Q_MSG_ERROR

static final int MQFB_XMIT_Q_MSG_ERROR
Value used with FEEDBACK_PROPERTY.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_PAN

static final int MQFB_PAN
Value used with FEEDBACK_PROPERTY to indicate an application specific positive acknowledge report.

See Also:
FEEDBACK_PROPERTY, REPORT_PAN_PROPERTY, Constant Field Values

MQFB_NAN

static final int MQFB_NAN
Value used with FEEDBACK_PROPERTY to indicate an application specific negative acknowledge report.

See Also:
FEEDBACK_PROPERTY, REPORT_NAN_PROPERTY, Constant Field Values

MQFB_SYSTEM_LAST

static final int MQFB_SYSTEM_LAST
Value used with FEEDBACK_PROPERTY to indicate the last value in the range reserved for system use.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_APPL_FIRST

static final int MQFB_APPL_FIRST
Value used with FEEDBACK_PROPERTY to indicate the first value in the range reserved for application use.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQFB_APPL_LAST

static final int MQFB_APPL_LAST
Value used with FEEDBACK_PROPERTY to indicate the last value in the range reserved for application use.

See Also:
FEEDBACK_PROPERTY, Constant Field Values

MQMT_REQUEST

static final int MQMT_REQUEST
Value used with MSG_TYPE_PROPERTY to indicate a request message.

See Also:
MSG_TYPE_PROPERTY, Constant Field Values

MQMT_REPORT

static final int MQMT_REPORT
Value used with MSG_TYPE_PROPERTY to indicate a report message.

See Also:
MSG_TYPE_PROPERTY, Constant Field Values

MQMT_DATAGRAM

static final int MQMT_DATAGRAM
Value used with MSG_TYPE_PROPERTY to indicate a datagram message.

See Also:
MSG_TYPE_PROPERTY, Constant Field Values

MQMT_APPL_FIRST

static final int MQMT_APPL_FIRST
Value used with MSG_TYPE_PROPERTY to indicate the first value in the range reserved for applications.

See Also:
MSG_TYPE_PROPERTY, Constant Field Values

MQMT_APPL_LAST

static final int MQMT_APPL_LAST
Value used with MSG_TYPE_PROPERTY to indicate the last value in the range reserved for applications.

See Also:
MSG_TYPE_PROPERTY, Constant Field Values

LAST_MSG_IN_GROUP_PROPERTY

static final java.lang.String LAST_MSG_IN_GROUP_PROPERTY
Name of the Last_Msg_In_Group property. This property is used in conjunction with the JMSXGroupID and JMSXGroupSeq properties, and when set to true indicates that the message is the last of a group of messages. When used with MQ interoperability, this property reflects/influences the appropriate bit of the MQMD.MsgFlags field.

See Also:
Constant Field Values

PUT_DATE_PROPERTY

static final java.lang.String PUT_DATE_PROPERTY
Name of the PutDate property. With MQ interoperability, this reflects the value of the MQMD.PutDate field for incoming messages. It is ignored on outgoing messages.

See Also:
Constant Field Values

PUT_TIME_PROPERTY

static final java.lang.String PUT_TIME_PROPERTY
Name of the PutTime property. With MQ interoperability, this reflects the value of the MQMD.PutTime field for incoming messages. It is ignored on outgoing messages.

See Also:
Constant Field Values

ENCODING_PROPERTY

static final java.lang.String ENCODING_PROPERTY
Name of the encoding property. This is used with BytesMessages to control the representation of numeric fields. With MQ interoperability, this reflects the value of the MQMD.Encoding field for incoming messages, and can be used to set the value on outgoing messages.

See Also:
Constant Field Values

CHARSET_PROPERTY

static final java.lang.String CHARSET_PROPERTY
Name of the character set property. With MQ interoperability, this reflects the value of the MQMD.CodedCharSetId field on incoming messages.

See Also:
Constant Field Values

EXCEPTION_MESSAGE

static final java.lang.String EXCEPTION_MESSAGE
Name of the Exception Message property. Generated when a message cannot be delivered to its final destination and is instead rerouted to an exception destination.

See Also:
Constant Field Values

EXCEPTION_TIMESTAMP

static final java.lang.String EXCEPTION_TIMESTAMP
Name of the Exception Timestamp property. Generated when a message cannot be delivered to its final destination and is instead rerouted to an exception destination.

See Also:
Constant Field Values

EXCEPTION_REASON

static final java.lang.String EXCEPTION_REASON
Name of the Exception Reason property. Generated when a message cannot be delivered to its final destination and is instead rerouted to an exception destination.

See Also:
Constant Field Values

SYSTEM_MESSAGEID_PROPERTY

static final java.lang.String SYSTEM_MESSAGEID_PROPERTY
Name of the system messageID property.

See Also:
Constant Field Values

EXCEPTION_PROBLEM_DESTINATION

static final java.lang.String EXCEPTION_PROBLEM_DESTINATION
Name of the exception problem destination property.

See Also:
Constant Field Values

EXCEPTION_PROBLEM_SUBSCRIPTION

static final java.lang.String EXCEPTION_PROBLEM_SUBSCRIPTION
Name of the exception problem subscription property.

See Also:
Constant Field Values

IBM_ARM_CORRELATOR

static final java.lang.String IBM_ARM_CORRELATOR
Constant for accessing the IBM ARM correlator property. Note that this IBM defined property is a synonym of the TOG ARM correlator. Setting one property will change the value of the other. This is a String-type property.

See Also:
Constant Field Values

TOG_ARM_CORRELATOR

static final java.lang.String TOG_ARM_CORRELATOR
Constant for accessing the The Open Group (TOG) ARM correlator property. Note that this property is a synonym of the IBM ARM correlator. Setting one property will change the value of the other. This is a String-type property.

See Also:
Constant Field Values

DELIVERY_MODE_APP

static final java.lang.String DELIVERY_MODE_APP
DeliveryMode constant for Destinations. If the destination contains this value for DeliveryMode, then the deliveryMode of sent messages is determined by the application.

See Also:
JmsDestination.setDeliveryMode(java.lang.String), Constant Field Values

DELIVERY_MODE_PERSISTENT

static final java.lang.String DELIVERY_MODE_PERSISTENT
DeliveryMode constant for Destinations. This value will override all messages sent using the Destination to be persistent.

See Also:
JmsDestination.setDeliveryMode(java.lang.String), Constant Field Values

DELIVERY_MODE_NONPERSISTENT

static final java.lang.String DELIVERY_MODE_NONPERSISTENT
DeliveryMode constant for Destinations. This value will override all messages sent using the Destination to be non-persistent.

See Also:
JmsDestination.setDeliveryMode(java.lang.String), Constant Field Values

MAX_TIME_TO_LIVE

static final long MAX_TIME_TO_LIVE
The maximum permitted value for timeToLive. This is equivalent to approximately 291 million years. The imposition of such a limit may appear arbitrary, but it prevents poorly defined behaviour which occurs if we permit values up to Long.MAX_VALUE.

See Also:
Constant Field Values

ENC_INTEGER_MASK

static final int ENC_INTEGER_MASK
Mask for the integer part of the JMS_IBM_Encoding field

See Also:
Constant Field Values

ENC_FLOAT_MASK

static final int ENC_FLOAT_MASK
Mask for the float part of the JMS_IBM_Encoding field

See Also:
Constant Field Values

ENC_INTEGER_UNDEFINED

static final int ENC_INTEGER_UNDEFINED
UNDEFINED value of integer encoding.

See Also:
Constant Field Values

ENC_INTEGER_NORMAL

static final int ENC_INTEGER_NORMAL
NORMAL value of integer encoding. When sending a JMS BytesMessage, integer fields will be sent using high byte first order when ENC_INTEGER_NORMAL is set in the JMS_IBM_Encoding field. This is also the default order used when JMS_IBM_Encoding is not set.

See Also:
Constant Field Values

ENC_INTEGER_REVERSED

static final int ENC_INTEGER_REVERSED
REVERSED value of integer encoding. When sending a JMS BytesMessage, integer fields will be sent using low byte first order when ENC_INTEGER_REVERSED is set in the JMS_IBM_Encoding field.

See Also:
Constant Field Values

ENC_FLOAT_UNDEFINED

static final int ENC_FLOAT_UNDEFINED
UNDEFINED value of floating point encoding.

See Also:
Constant Field Values

ENC_FLOAT_IEEE_NORMAL

static final int ENC_FLOAT_IEEE_NORMAL
NORMAL value of floating point encoding. When sending a JMS BytesMessage, floating point fields will be sent using IEEE encoding in high byte first order when ENC_FLOAT_IEEE_NORMAL is set in the JMS_IBM_Encoding field. This is also the default order used when JMS_IBM_Encoding is not set.

See Also:
Constant Field Values

ENC_FLOAT_IEEE_REVERSED

static final int ENC_FLOAT_IEEE_REVERSED
REVERSED value of floating point encoding. When sending a JMS BytesMessage, floating point fields will be sent using IEEE encoding in low byte first order when ENC_FLOAT_IEEE_REVERSED is set in the JMS_IBM_Encoding field.

See Also:
Constant Field Values

ENC_FLOAT_S390

static final int ENC_FLOAT_S390
S390 value of floating point encoding. When sending a JMS BytesMessage, floating point fields will be sent using a S390 specific format when ENC_FLOAT_IEEE_NORMAL is set in the JMS_IBM_Encoding field.

See Also:
Constant Field Values

JMSX_USERID

static final java.lang.String JMSX_USERID
A constant for the JMSXUserID property name.

See Also:
Constant Field Values

JMSX_DELIVERY_COUNT

static final java.lang.String JMSX_DELIVERY_COUNT
A constant for the JMSXDeliveryCount property name.

See Also:
Constant Field Values

JMSX_APPID

static final java.lang.String JMSX_APPID
A constant for the JMSXAppID property name.

See Also:
Constant Field Values

JMSX_GROUPID

static final java.lang.String JMSX_GROUPID
A constant for the JMSXGroupID property name.

See Also:
Constant Field Values

JMSX_GROUPSEQ

static final java.lang.String JMSX_GROUPSEQ
A constant for the JMSXGroupSeq property name.

See Also:
Constant Field Values

JMS_IBM_MQMD_PERSISTENCE

static final java.lang.String JMS_IBM_MQMD_PERSISTENCE
A constant for the JMS_IBM_MQMD_Persistence property name.

See Also:
Constant Field Values

JMS_IBM_MQMD_MSGID

static final java.lang.String JMS_IBM_MQMD_MSGID
A constant for the JMS_IBM_MQMD_MsgId property name.

See Also:
Constant Field Values

JMS_IBM_MQMD_CORRELID

static final java.lang.String JMS_IBM_MQMD_CORRELID
A constant for the JMS_IBM_MQMD_CorrelId property name.

See Also:
Constant Field Values

JMS_IBM_MQMD_REPLYTOQ

static final java.lang.String JMS_IBM_MQMD_REPLYTOQ
A constant for the JMS_IBM_MQMD_ReplyToQ property name.

See Also:
Constant Field Values

JMS_IBM_MQMD_REPLYTOQMGR

static final java.lang.String JMS_IBM_MQMD_REPLYTOQMGR
A constant for the JMS_IBM_MQMD_ReplyToQMgr property name.

See Also:
Constant Field Values

MIGHT_MODIFY_PAYLOAD

static final java.lang.String MIGHT_MODIFY_PAYLOAD
Constant - one of the possible values of the ConnectionFactory properties:

See Also:
Constant Field Values

WILL_NOT_MODIFY_PAYLOAD

static final java.lang.String WILL_NOT_MODIFY_PAYLOAD
Constant - one of the possible values of the ConnectionFactory properties:

See Also:
Constant Field Values

IBM WebSphere Application ServerTM
Release 8