SonicMQ API

progress.message.jclient
Class Constants

java.lang.Object
  extended by progress.message.jclient.Constants

public final class Constants
extends java.lang.Object

General constants available for user coding. UNDELIVERED_<> constants are used as reason codes for messages that cannot be delivered and may have been transfered to a system queue (e.g. "SonicMQ.deadMessage"). Messages transfered to such a queue will have the header int property JMS_SonicMQ_undeliveredReasonCode set to one of these values.


Field Summary
static int ACTIVE
          Connection state for an active JMS connection (normal state)
static java.lang.Integer ASYNC_DELIVERY_MODE_DEFAULT
          This constant can be used with ConnectionFactory.setAsynchronousDeliveryMode(Integer).
static java.lang.Integer ASYNC_DELIVERY_MODE_DISABLED
          This constant is used to specify synchronous delivery mode with ConnectionFactory.setAsynchronousDeliveryMode(Integer).
static java.lang.Integer ASYNC_DELIVERY_MODE_ENABLED
          This constant is used to specify asynchronous message delivery with ConnectionFactory.setAsynchronousDeliveryMode(Integer).
static java.lang.String CHANNEL
          Named of the message property set by SonicMQ when a channel is attached to a message.
static int CLOSED
          Connection state constant for a closed JMS connection
static java.lang.String CTS_TEST_MESSAGE
          Name of message property that, if true, that message was sent or published from a com.sun.cts.tests.jms.common.MessageTestImpl message.
static java.lang.String DEAD_MESSAGE_QUEUE
          The name of the Dead Message Queue in the client.
static java.lang.String DESTINATION_UNDELIVERED
          Name of message property that specifies an alternative destination for the message instead of dead message queue in case the message is declared undeliverable.
static java.lang.String DESTINATION_URL
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String ENCRYPT_MESSAGE
          A user can request per-message encryption by setting this property to true on a message.
static java.lang.String EXTENDED_TYPE
          Name of message property to indicate that the message is a SonicMQ_ExtendedType message.
static java.lang.String EXTENDED_TYPE_VALUE
           
static int FAILED
          Connection state for a failed JMS connection.
static int FLOW_TO_DISK_OFF
          FLOW_TO_DISK feature is off, specifies that the broker's behavior is compatible with the 5.0 and earlier releases, whenever at least one subscriber's buffer is full, the publishing application is blocked until the subscriber processes more messages.
static int FLOW_TO_DISK_ON
          FLOW_TO_DISK feature is on, specifies that whenever a subscriber's in-memory buffer is full the broker will offload the messages for the subscriber to the database without blocking the publisher(s).
static int FLOW_TO_DISK_USE_BROKER_SETTING
          This is the default setting for the FLOW_TO_DISK feature, indicating that there is no setting on the client side for the FLOW_TO_DISK feature, thus the broker side setting of FLOW_TO_DISK will be used.
static java.lang.String HTTP_AUTH_PASSWORD
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTP_AUTH_USER
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTP_CONTENT_LENGTH
          JMS message header int property for HTTP Direct.
static java.lang.String HTTP_REPLY_AS_SOAP
          JMS message header boolean property for HTTP Direct Outbound.
static java.lang.String HTTP_RESPONSE_CODE
          JMS message header int property for HTTP Direct.
static java.lang.String HTTP_RESPONSE_MESSAGE
          JMS message header String property for HTTP Direct.
static java.lang.String HTTPS_CA_CERTIFICATE_DN
          JMS message header String property for HTTP Direct.
static java.lang.String HTTPS_CA_CERTIFICATE_PATH
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTPS_CERTIFICATE_CN
          JMS message header String property for HTTP Direct.
static java.lang.String HTTPS_CERTIFICATE_DN
          JMS message header String property for HTTP Direct.
static java.lang.String HTTPS_CIPHER_SUITES
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTPS_CLIENT_AUTH_CERTIFICATE
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTPS_CLIENT_AUTH_CERTIFICATE_FORM
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTPS_PRIVATE_KEY
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String HTTPS_PRIVATE_KEY_PASSWORD
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String LAST_MESSAGE_IN_GROUP
          Name of message property that, if true, marks a last message in a group of messages.
static java.lang.String NOTIFY_UNDELIVERED
          Name of message property that, if true, causes an administrative event to be sent to the management tools when the message is declared undeliverable.
static java.lang.String OUTBOUND_GROUP_ID
          JMS message header String property for HTTP Direct Outbound.
static java.lang.String PRESERVE_UNDELIVERED
          Name of message property that, if true, causes the message to be enqueued on the dead message queue when it is declared undeliverable.
static int RECONNECTING
          Connection state for a reconnecting fault-tolerant JMS connection.
static java.lang.String REQUEST_TIMEOUT
          JMS message header int property for HTTP Direct Outbound.
static java.lang.String RETRIES
          JMS message header int property for HTTP Direct Outbound.
static java.lang.String RETRY_INTERVAL
          JMS message header int property for HTTP Direct Outbound.
static java.lang.String SENDER_ID_PROPERTY
          Name of JMS message property that holds the message sender ID
static java.lang.String UNDELIVERED_BROKER_NAME
          Name of message property that holds the name of the broker that declared a message to be undeliverable.
static int UNDELIVERED_DELIVERY_LIMIT_EXCEEDED
          Message has been marked as undelivered because the application-specified delivery limit has been exceeded.
static java.lang.String UNDELIVERED_EXPLANATION_TEXT
           
static int UNDELIVERED_HTTP_AUTHENTICATION_FAILURE
          Message intended for dynamic routing over HTTP was rejected by the destination server because the supplied username/password or certificate was invalid.
static int UNDELIVERED_HTTP_BAD_REQUEST
          Message intended for dynamic routing over HTTP was rejected by the destination server because the format of the HTTP request was not valid (e.g., missing property).
static int UNDELIVERED_HTTP_FILE_NOT_FOUND
          Message intended for dynamic routing over HTTP has been marked undelivered.
static int UNDELIVERED_HTTP_GENERAL_ERROR
          Message intended for dynamic routing over HTTP was marked undeliverable for unknown reasons, or for reasons not covered by the other DMQ codes.
static int UNDELIVERED_HTTP_HOST_UNREACHABLE
          Message intended for dynamic routing over HTTP has been marked undelivered for one of the following reasons: 1) a connection cannot be made to the HTTP destination, 2) the request has timed out, or 3) the destination is flow-controlled (this generally only occurs for broker-to-broker).
static int UNDELIVERED_HTTP_INTERNAL_ERROR
          Message intended for dynamic routing over HTTP was not sent because the destination service was unable to process the request.
static int UNDELIVERED_HTTP_INVALID_SOAP_CONTENT
          Message could not be delivered to the destination because the JMS message payload contains invalid soap content.
static int UNDELIVERED_HTTP_PROTOCOL_NOT_SUPPORTED
          Message intended for dynamic routing over HTTP has been marked undelivered because the request was sent to an unregistered URL (in other words, there is no protocol handler listening for requests on that URL).
static int UNDELIVERED_HTTP_REQUEST_TOO_LARGE
          Message intended for dynamic routing over HTTP was not sent because the HTTP request was too large.
static int UNDELIVERED_INVALID_PROPERTY_TYPE
           
static int UNDELIVERED_JMS_QUEUE_NOT_FOUND
          Message could not be delivered to the destination queue because the queue is not found.
static int UNDELIVERED_MESSAGE_TOO_LARGE_FOR_QUEUE
          Message could not be delivered to the destination queue because it is larger than the maximum size of the queue.
static java.lang.String UNDELIVERED_NODE_NAME
          Name of message property that holds the name of the routing node where a message was declared to be undeliverable.
static java.lang.String UNDELIVERED_ORIGINAL_DESTINATION
          Name of the propert that holds the original destination of a message that became undelivered.
static java.lang.String UNDELIVERED_ORIGINAL_EXPIRATION
          Name of the propert that holds the original TTL of a message that became undelivered.
static java.lang.String UNDELIVERED_ORIGINAL_TIMESTAMP
          Name of the propert that holds the original timestamp of a message that became undelivered.
static java.lang.String UNDELIVERED_PREFIX
           
static int UNDELIVERED_QUEUE_FULL
           
static java.lang.String UNDELIVERED_REASON_ADDED_TO_DMQ
          Name of message property that describes the reason a message was enqueued on the dead message queue after it was declared to be undeliverable even though the message producer specified a different destination in the DESTINATION_UNDELIVERED message property.
static java.lang.String UNDELIVERED_REASON_CODE
          Name of message property that describes the reason a message was declared to be undeliverable.
static java.lang.String[] UNDELIVERED_REASONS
          Converts an "undelivered reason code" into a string.
static int UNDELIVERED_ROUTING_CONNECTION_AUTHENTICATION_FAILURE
          Message with routing information could not be delivered to specified node due to authentication (invalid credentials) error while establishing connection to remote broker Since the message cannot be forwarded on to a remote broker, it will be placed on the dead message queue.
static int UNDELIVERED_ROUTING_CONNECTION_AUTHORIZATION_FAILURE
          Message with routing information could not be delivered to specified node due to authorization (insufficient permissions) error while establishing connection to remote broker Since the message cannot be forwarded on to a remote broker, it will be placed on the dead message queue.
static int UNDELIVERED_ROUTING_INDOUBT
          Message has been marked as undelivered by a broker because it has been left in an "in doubt" state during its transfer between brokers.
static int UNDELIVERED_ROUTING_INVALID_DESTINATION
          Message has been marked as undelivered by a broker which has received a message from a remote routing node.
static int UNDELIVERED_ROUTING_INVALID_NODE
          Message has been marked as undelivered while in the broker's routing queue because the target routing node in the destination cannot be found in the broker's list of routing connections.
static int UNDELIVERED_ROUTING_MULTI_TOPICS_NOT_SUPPORTED
          Message could not be delivered to the remote node because the destination routing node does not support MultiTopic messages.
static int UNDELIVERED_ROUTING_NOT_ENABLED
          Deprecated. Routing is always enabled on a broker.

Since the message cannot be forwarded on to a remote broker, it will be placed on the dead message queue.

static int UNDELIVERED_ROUTING_REMOTE_SUBSCRIPTIONS_NOT_SUPPORTED
          Subscription request could not be delivered to the destination because the remote node doesn't support remote subscriptions.
static int UNDELIVERED_ROUTING_SUBSCRIPTION_AUTHORIZATION_FAILURE
          Subscription request could not be delivered to the destination because the remote node denies subscribe permission to the subscription's topic.
static int UNDELIVERED_ROUTING_TIMEOUT
          Message has been marked as undelivered by a broker because a remote connection to the destination routing node cannot be established over an extended period of time.
static int UNDELIVERED_ROUTING_TOPIC_MESSAGES_NOT_SUPPORTED
          Message could not be delivered to the destination because the remote node doesn't support remote topic messages.
static java.lang.String UNDELIVERED_TIMESTAMP
          Name of message property that states the time when a message was declared to be undeliverable.
static int UNDELIVERED_TOPIC_FULL
           
static int UNDELIVERED_TTL_EXPIRED
          Message has been marked as undelivered because the current system time on the broker (as GMT) exceeds the message's expiration time.
static int UNDELIVERED_UNKNOWN_REASON
          Message has been marked as undelivered for an unknown reason.
static int UNDELIVERED_UNSUPPORTED_OVERRIDE_DESTINATION
           
static java.lang.String WS_MESSAGE_POLICY
          JMS message header String property for HTTP Direct Outbound Web Service support.
static java.lang.String WS_MESSAGE_POLICY_OUT
          JMS message header String property for HTTP Direct Outbound Web Service support.
 
Constructor Summary
Constants()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNDELIVERED_UNKNOWN_REASON

public static final int UNDELIVERED_UNKNOWN_REASON
Message has been marked as undelivered for an unknown reason. This value will typically never be seen and is included for completeness.

See Also:
Constant Field Values

UNDELIVERED_TTL_EXPIRED

public static final int UNDELIVERED_TTL_EXPIRED
Message has been marked as undelivered because the current system time on the broker (as GMT) exceeds the message's expiration time.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_NOT_ENABLED

public static final int UNDELIVERED_ROUTING_NOT_ENABLED
Deprecated. Routing is always enabled on a broker.

Since the message cannot be forwarded on to a remote broker, it will be placed on the dead message queue.

Message with routing information arrived at a broker that does not currently have routing enabled.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_INVALID_NODE

public static final int UNDELIVERED_ROUTING_INVALID_NODE
Message has been marked as undelivered while in the broker's routing queue because the target routing node in the destination cannot be found in the broker's list of routing connections.

Typically, this is a programmer or administrative error. The routing node in the destination set by the JMS client does not exist in the set of valid routing connections for this broker.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_INVALID_DESTINATION

public static final int UNDELIVERED_ROUTING_INVALID_DESTINATION
Message has been marked as undelivered by a broker which has received a message from a remote routing node. The message is undeliverable because no destination exists in the current broker or routing node for the destination.

Typically, this is a programmer error at the sending routing node where an invalid destination has been used. It can also arise if a queue was removed from a broker while a message was on route.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_TIMEOUT

public static final int UNDELIVERED_ROUTING_TIMEOUT
Message has been marked as undelivered by a broker because a remote connection to the destination routing node cannot be established over an extended period of time. The routing connection itself is considered to have timed out, and messages are marked as undeliverd.

Typically, this is due to network error, or simply because the remote system has not been started.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_INDOUBT

public static final int UNDELIVERED_ROUTING_INDOUBT
Message has been marked as undelivered by a broker because it has been left in an "in doubt" state during its transfer between brokers.

Typically, this occurs due to a network failure that occurs after some message has been sent between brokers, but the acknowledgement cycle has not completed.

The brokers will make an effort to reestablish the connection and resolve the ambiguity, but if this state persists for a period of time, then the indoubt messages are marked as undelivered.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_CONNECTION_AUTHENTICATION_FAILURE

public static final int UNDELIVERED_ROUTING_CONNECTION_AUTHENTICATION_FAILURE
Message with routing information could not be delivered to specified node due to authentication (invalid credentials) error while establishing connection to remote broker

Since the message cannot be forwarded on to a remote broker, it will be placed on the dead message queue.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_CONNECTION_AUTHORIZATION_FAILURE

public static final int UNDELIVERED_ROUTING_CONNECTION_AUTHORIZATION_FAILURE
Message with routing information could not be delivered to specified node due to authorization (insufficient permissions) error while establishing connection to remote broker

Since the message cannot be forwarded on to a remote broker, it will be placed on the dead message queue.

See Also:
Constant Field Values

UNDELIVERED_MESSAGE_TOO_LARGE_FOR_QUEUE

public static final int UNDELIVERED_MESSAGE_TOO_LARGE_FOR_QUEUE
Message could not be delivered to the destination queue because it is larger than the maximum size of the queue.

See Also:
Constant Field Values

UNDELIVERED_HTTP_GENERAL_ERROR

public static final int UNDELIVERED_HTTP_GENERAL_ERROR
Message intended for dynamic routing over HTTP was marked undeliverable for unknown reasons, or for reasons not covered by the other DMQ codes. This code may also be used when the server is unable to distinguish among HTTP error codes (in which case an explanation text should also be provided).

See Also:
Constant Field Values

UNDELIVERED_HTTP_HOST_UNREACHABLE

public static final int UNDELIVERED_HTTP_HOST_UNREACHABLE
Message intended for dynamic routing over HTTP has been marked undelivered for one of the following reasons: 1) a connection cannot be made to the HTTP destination, 2) the request has timed out, or 3) the destination is flow-controlled (this generally only occurs for broker-to-broker).

See Also:
Constant Field Values

UNDELIVERED_HTTP_BAD_REQUEST

public static final int UNDELIVERED_HTTP_BAD_REQUEST
Message intended for dynamic routing over HTTP was rejected by the destination server because the format of the HTTP request was not valid (e.g., missing property).

See Also:
Constant Field Values

UNDELIVERED_HTTP_AUTHENTICATION_FAILURE

public static final int UNDELIVERED_HTTP_AUTHENTICATION_FAILURE
Message intended for dynamic routing over HTTP was rejected by the destination server because the supplied username/password or certificate was invalid.

See Also:
Constant Field Values

UNDELIVERED_HTTP_FILE_NOT_FOUND

public static final int UNDELIVERED_HTTP_FILE_NOT_FOUND
Message intended for dynamic routing over HTTP has been marked undelivered. This error is only relevant because jdk1.3 will throw a FileNotFoundException when it receives an http status code > 300.

See Also:
Constant Field Values

UNDELIVERED_HTTP_REQUEST_TOO_LARGE

public static final int UNDELIVERED_HTTP_REQUEST_TOO_LARGE
Message intended for dynamic routing over HTTP was not sent because the HTTP request was too large.

See Also:
Constant Field Values

UNDELIVERED_HTTP_INTERNAL_ERROR

public static final int UNDELIVERED_HTTP_INTERNAL_ERROR
Message intended for dynamic routing over HTTP was not sent because the destination service was unable to process the request.

See Also:
Constant Field Values

UNDELIVERED_HTTP_PROTOCOL_NOT_SUPPORTED

public static final int UNDELIVERED_HTTP_PROTOCOL_NOT_SUPPORTED
Message intended for dynamic routing over HTTP has been marked undelivered because the request was sent to an unregistered URL (in other words, there is no protocol handler listening for requests on that URL).

See Also:
Constant Field Values

UNDELIVERED_ROUTING_TOPIC_MESSAGES_NOT_SUPPORTED

public static final int UNDELIVERED_ROUTING_TOPIC_MESSAGES_NOT_SUPPORTED
Message could not be delivered to the destination because the remote node doesn't support remote topic messages.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_SUBSCRIPTION_AUTHORIZATION_FAILURE

public static final int UNDELIVERED_ROUTING_SUBSCRIPTION_AUTHORIZATION_FAILURE
Subscription request could not be delivered to the destination because the remote node denies subscribe permission to the subscription's topic.

See Also:
Constant Field Values

UNDELIVERED_ROUTING_REMOTE_SUBSCRIPTIONS_NOT_SUPPORTED

public static final int UNDELIVERED_ROUTING_REMOTE_SUBSCRIPTIONS_NOT_SUPPORTED
Subscription request could not be delivered to the destination because the remote node doesn't support remote subscriptions.

See Also:
Constant Field Values

UNDELIVERED_HTTP_INVALID_SOAP_CONTENT

public static final int UNDELIVERED_HTTP_INVALID_SOAP_CONTENT
Message could not be delivered to the destination because the JMS message payload contains invalid soap content.

See Also:
Constant Field Values

UNDELIVERED_JMS_QUEUE_NOT_FOUND

public static final int UNDELIVERED_JMS_QUEUE_NOT_FOUND
Message could not be delivered to the destination queue because the queue is not found.

See Also:
Constant Field Values

UNDELIVERED_QUEUE_FULL

public static final int UNDELIVERED_QUEUE_FULL
See Also:
Constant Field Values

UNDELIVERED_TOPIC_FULL

public static final int UNDELIVERED_TOPIC_FULL
See Also:
Constant Field Values

UNDELIVERED_UNSUPPORTED_OVERRIDE_DESTINATION

public static final int UNDELIVERED_UNSUPPORTED_OVERRIDE_DESTINATION
See Also:
Constant Field Values

UNDELIVERED_INVALID_PROPERTY_TYPE

public static final int UNDELIVERED_INVALID_PROPERTY_TYPE
See Also:
Constant Field Values

UNDELIVERED_ROUTING_MULTI_TOPICS_NOT_SUPPORTED

public static final int UNDELIVERED_ROUTING_MULTI_TOPICS_NOT_SUPPORTED
Message could not be delivered to the remote node because the destination routing node does not support MultiTopic messages.

See Also:
Constant Field Values

UNDELIVERED_DELIVERY_LIMIT_EXCEEDED

public static final int UNDELIVERED_DELIVERY_LIMIT_EXCEEDED
Message has been marked as undelivered because the application-specified delivery limit has been exceeded.

See Also:
Constant Field Values

UNDELIVERED_REASONS

public static java.lang.String[] UNDELIVERED_REASONS
Converts an "undelivered reason code" into a string.

See Also:
Constants

PRESERVE_UNDELIVERED

public static final java.lang.String PRESERVE_UNDELIVERED
Name of message property that, if true, causes the message to be enqueued on the dead message queue when it is declared undeliverable. This is a SonicMQ extenstion to the Java Messaging Specification.

See Also:
Constant Field Values

DESTINATION_UNDELIVERED

public static final java.lang.String DESTINATION_UNDELIVERED
Name of message property that specifies an alternative destination for the message instead of dead message queue in case the message is declared undeliverable. This is a SonicMQ extenstion to the Java Messaging Specification.

See Also:
Constant Field Values

CTS_TEST_MESSAGE

public static final java.lang.String CTS_TEST_MESSAGE
Name of message property that, if true, that message was sent or published from a com.sun.cts.tests.jms.common.MessageTestImpl message. This is a SonicMQ extenstion to the Java Messaging Specification.

See Also:
Constant Field Values

NOTIFY_UNDELIVERED

public static final java.lang.String NOTIFY_UNDELIVERED
Name of message property that, if true, causes an administrative event to be sent to the management tools when the message is declared undeliverable. This is a SonicMQ extenstion to the Java Messaging Specification.

See Also:
Constant Field Values

UNDELIVERED_REASON_CODE

public static final java.lang.String UNDELIVERED_REASON_CODE
Name of message property that describes the reason a message was declared to be undeliverable. This property is set by the SonicMQ broker when a message is enqueued on the dead message queue.

See Also:
Constant Field Values

UNDELIVERED_TIMESTAMP

public static final java.lang.String UNDELIVERED_TIMESTAMP
Name of message property that states the time when a message was declared to be undeliverable. This property is set by the SonicMQ broker when a message is enqueued on the dead message queue.

See Also:
Constant Field Values

UNDELIVERED_BROKER_NAME

public static final java.lang.String UNDELIVERED_BROKER_NAME
Name of message property that holds the name of the broker that declared a message to be undeliverable. This property is set by the SonicMQ broker when a message is forwarded to the destination specified by the DESTINATION_UNDELIVERED message property set by the message producer.

See Also:
Constant Field Values

UNDELIVERED_NODE_NAME

public static final java.lang.String UNDELIVERED_NODE_NAME
Name of message property that holds the name of the routing node where a message was declared to be undeliverable. This property is set by the SonicMQ broker when a message is forwarded to the destination specified by the DESTINATION_UNDELIVERED message property set by the message producer.

See Also:
Constant Field Values

UNDELIVERED_ORIGINAL_DESTINATION

public static final java.lang.String UNDELIVERED_ORIGINAL_DESTINATION
Name of the propert that holds the original destination of a message that became undelivered. This property is set by the SonicMQ broker when a message is forwarded to the destination specified by the DESTINATION_UNDELIVERED message property set by the message producer.

See Also:
Constant Field Values

UNDELIVERED_ORIGINAL_EXPIRATION

public static final java.lang.String UNDELIVERED_ORIGINAL_EXPIRATION
Name of the propert that holds the original TTL of a message that became undelivered. This property is set by the SonicMQ broker when a message is forwarded to the destination specified by the DESTINATION_UNDELIVERED message property set by the message producer.

See Also:
Constant Field Values

UNDELIVERED_ORIGINAL_TIMESTAMP

public static final java.lang.String UNDELIVERED_ORIGINAL_TIMESTAMP
Name of the propert that holds the original timestamp of a message that became undelivered. This property is set by the SonicMQ broker when a message is forwarded to the destination specified by the DESTINATION_UNDELIVERED message property set by the message producer.

See Also:
Constant Field Values

UNDELIVERED_REASON_ADDED_TO_DMQ

public static final java.lang.String UNDELIVERED_REASON_ADDED_TO_DMQ
Name of message property that describes the reason a message was enqueued on the dead message queue after it was declared to be undeliverable even though the message producer specified a different destination in the DESTINATION_UNDELIVERED message property. This property is set by the SonicMQ broker when a message is forwarded to the destination specified by the DESTINATION_UNDELIVERED message property set by the message producer.

See Also:
Constant Field Values

ENCRYPT_MESSAGE

public static final java.lang.String ENCRYPT_MESSAGE
A user can request per-message encryption by setting this property to true on a message.

See Also:
Constant Field Values

DEAD_MESSAGE_QUEUE

public static final java.lang.String DEAD_MESSAGE_QUEUE
The name of the Dead Message Queue in the client. (i.e. SonicMQ.deadMessage)

See Also:
Constant Field Values

LAST_MESSAGE_IN_GROUP

public static final java.lang.String LAST_MESSAGE_IN_GROUP
Name of message property that, if true, marks a last message in a group of messages. Complements the standard properties, JMSXGroupID and JMSXGroupSeq, that clients use if they want to group messages. This is a SonicMQ extenstion to the Java Messaging Specification.

See Also:
Constant Field Values

EXTENDED_TYPE

public static final java.lang.String EXTENDED_TYPE
Name of message property to indicate that the message is a SonicMQ_ExtendedType message. This property is set by SonicMQ when a message is published or sent. in current realease, this property is set for every message. When a MultipartMessage is sent, this property is set to be "x-sonicmq-multipart". For other messages, the property is set to be null.

See Also:
Constant Field Values

EXTENDED_TYPE_VALUE

public static final java.lang.String EXTENDED_TYPE_VALUE
See Also:
Constant Field Values

CHANNEL

public static final java.lang.String CHANNEL
Named of the message property set by SonicMQ when a channel is attached to a message.

See Also:
Constant Field Values

UNDELIVERED_PREFIX

public static final java.lang.String UNDELIVERED_PREFIX
See Also:
Constant Field Values

UNDELIVERED_EXPLANATION_TEXT

public static final java.lang.String UNDELIVERED_EXPLANATION_TEXT
See Also:
Constant Field Values

ACTIVE

public static final int ACTIVE
Connection state for an active JMS connection (normal state)

See Also:
Constant Field Values

RECONNECTING

public static final int RECONNECTING
Connection state for a reconnecting fault-tolerant JMS connection. The connection has detected a failure and is attempting to reconnect automatically.

See Also:
Constant Field Values

FAILED

public static final int FAILED
Connection state for a failed JMS connection.

See Also:
Constant Field Values

CLOSED

public static final int CLOSED
Connection state constant for a closed JMS connection

See Also:
Constant Field Values

FLOW_TO_DISK_USE_BROKER_SETTING

public static final int FLOW_TO_DISK_USE_BROKER_SETTING
This is the default setting for the FLOW_TO_DISK feature, indicating that there is no setting on the client side for the FLOW_TO_DISK feature, thus the broker side setting of FLOW_TO_DISK will be used.

See Also:
Constant Field Values

FLOW_TO_DISK_ON

public static final int FLOW_TO_DISK_ON
FLOW_TO_DISK feature is on, specifies that whenever a subscriber's in-memory buffer is full the broker will offload the messages for the subscriber to the database without blocking the publisher(s).

See Also:
Constant Field Values

FLOW_TO_DISK_OFF

public static final int FLOW_TO_DISK_OFF
FLOW_TO_DISK feature is off, specifies that the broker's behavior is compatible with the 5.0 and earlier releases, whenever at least one subscriber's buffer is full, the publishing application is blocked until the subscriber processes more messages.

See Also:
Constant Field Values

DESTINATION_URL

public static final java.lang.String DESTINATION_URL
JMS message header String property for HTTP Direct Outbound. The connection URL used at the outbound message's destination is defined as part of the routing node. This destination can be overridden on any message sent to a routing node by setting a user-defined property in the JMS message, X-HTTPDestinationURL, with a String value that specifies the overriding URL. The ConnectionURL's declared protocol and parameters are used. On the default routing definition, the default value is localhost. The default protocol is http and the default port is 80.

See Also:
Constant Field Values

REQUEST_TIMEOUT

public static final java.lang.String REQUEST_TIMEOUT
JMS message header int property for HTTP Direct Outbound. Timeout in seconds for the broker to wait for the response from the HTTP URL. The default value is 30 seconds.

See Also:
RETRIES, RETRY_INTERVAL, Constant Field Values

RETRIES

public static final java.lang.String RETRIES
JMS message header int property for HTTP Direct Outbound. Number of connection retries when a broker connection fails or there is no response to an HTTP request. The default value is 30 seconds.

See Also:
REQUEST_TIMEOUT, RETRY_INTERVAL, Constant Field Values

RETRY_INTERVAL

public static final java.lang.String RETRY_INTERVAL
JMS message header int property for HTTP Direct Outbound. Interval (in seconds) between HTTP retry attempts. The default value is 0 seconds.

See Also:
RETRIES, REQUEST_TIMEOUT, Constant Field Values

OUTBOUND_GROUP_ID

public static final java.lang.String OUTBOUND_GROUP_ID
JMS message header String property for HTTP Direct Outbound. Messages with the same group ID must be delivered in the order they are received by the broker. See the SonicMQ Deployment Guide, Chapter "HTTP Direct Acceptors and Routing", Section "Enabling Ordering of Messages on a Routing Node" for more information.

See Also:
Constant Field Values

HTTPS_CERTIFICATE_DN

public static final java.lang.String HTTPS_CERTIFICATE_DN
JMS message header String property for HTTP Direct. For JMS messages that are a result of HTTP Direct, stores the HTTPS peer certificate DN.

See Also:
Constant Field Values

HTTPS_CERTIFICATE_CN

public static final java.lang.String HTTPS_CERTIFICATE_CN
JMS message header String property for HTTP Direct. For JMS messages that are a result of HTTP Direct, stores the HTTPS peer certificate CN.

See Also:
Constant Field Values

HTTPS_CA_CERTIFICATE_DN

public static final java.lang.String HTTPS_CA_CERTIFICATE_DN
JMS message header String property for HTTP Direct. For JMS messages that are a result of HTTP Direct, stores the HTTPS peer Certificate Authority DN.

See Also:
Constant Field Values

HTTP_AUTH_USER

public static final java.lang.String HTTP_AUTH_USER
JMS message header String property for HTTP Direct Outbound. Provides the HTTP Basic Authentication name for Web Server basic authentication.

See Also:
Constant Field Values

HTTP_AUTH_PASSWORD

public static final java.lang.String HTTP_AUTH_PASSWORD
JMS message header String property for HTTP Direct Outbound. Provides the HTTP Basic Authentication password for Web Server basic authentication.

See Also:
Constant Field Values

HTTP_RESPONSE_CODE

public static final java.lang.String HTTP_RESPONSE_CODE
JMS message header int property for HTTP Direct. For HTTP Direct Inbound, and, for HTTP Direct Outbound, when ContentReply is elected and ReplyTo is specified, HTTP Response-Code is stored as the int property X-HTTP-ResponseCode in the resulting JMS message

See Also:
Constant Field Values

HTTP_RESPONSE_MESSAGE

public static final java.lang.String HTTP_RESPONSE_MESSAGE
JMS message header String property for HTTP Direct. For HTTP Direct Inbound, and, for HTTP Direct Outbound, when ContentReply is elected and ReplyTo is specified, HTTP Response-Message is stored as the String property X-HTTP-ResponseMessage in the resulting JMS message.

See Also:
Constant Field Values

HTTP_CONTENT_LENGTH

public static final java.lang.String HTTP_CONTENT_LENGTH
JMS message header int property for HTTP Direct. For HTTP Direct Inbound, and, for HTTP Direct Outbound, when When ContentReply is elected and ReplyTo is specified, HTTP Content-Length is stored as the int property X-HTTP-ContentLength in the resulting JMS message.

See Also:
Constant Field Values

HTTP_REPLY_AS_SOAP

public static final java.lang.String HTTP_REPLY_AS_SOAP
JMS message header boolean property for HTTP Direct Outbound. Used to indicate that all error messages internally generated by the HTTP Outbound Handler should be SOAP Faults.

See Also:
Constant Field Values

HTTPS_CIPHER_SUITES

public static final java.lang.String HTTPS_CIPHER_SUITES
JMS message header String property for HTTP Direct Outbound. Used to supply the cipher suites when making an HTTPS(RSA) connection. comma- delimited list of cipher names.

See Also:
Constant Field Values

HTTPS_CLIENT_AUTH_CERTIFICATE

public static final java.lang.String HTTPS_CLIENT_AUTH_CERTIFICATE
JMS message header String property for HTTP Direct Outbound. Used to supply the client certificate to present to the HTTPS Server when making an HTTPS(RSA) connection.

See Also:
HTTPS_CLIENT_AUTH_CERTIFICATE_FORM, Constant Field Values

HTTPS_CLIENT_AUTH_CERTIFICATE_FORM

public static final java.lang.String HTTPS_CLIENT_AUTH_CERTIFICATE_FORM
JMS message header String property for HTTP Direct Outbound. Format of the client certificate when making an HTTPS(RSA) connection.

See Also:
HTTPS_CLIENT_AUTH_CERTIFICATE, Constant Field Values

HTTPS_PRIVATE_KEY

public static final java.lang.String HTTPS_PRIVATE_KEY
JMS message header String property for HTTP Direct Outbound. Used to supply the client private key file when making an HTTPS(RSA) connection.

See Also:
HTTPS_PRIVATE_KEY_PASSWORD, Constant Field Values

HTTPS_PRIVATE_KEY_PASSWORD

public static final java.lang.String HTTPS_PRIVATE_KEY_PASSWORD
JMS message header String property for HTTP Direct Outbound. Used to supply the client private key file password when making an HTTPS(RSA) connection.

See Also:
HTTPS_PRIVATE_KEY, Constant Field Values

HTTPS_CA_CERTIFICATE_PATH

public static final java.lang.String HTTPS_CA_CERTIFICATE_PATH
JMS message header String property for HTTP Direct Outbound. Path for the trusted CA certificates, absolute or relative to the broker's installation directory

See Also:
Constant Field Values

WS_MESSAGE_POLICY

public static final java.lang.String WS_MESSAGE_POLICY
JMS message header String property for HTTP Direct Outbound Web Service support. The property is expected to contain a normalized WS-Policy expression to be used with the message.

See Also:
Constant Field Values

WS_MESSAGE_POLICY_OUT

public static final java.lang.String WS_MESSAGE_POLICY_OUT
JMS message header String property for HTTP Direct Outbound Web Service support. The property is expected to contain a normalized WS-Policy expression to be applied against a reply(synchronous or asynchronous) received for an outbound request. "Out" refers to the (reply) outbound message of a WSDL operation.

See Also:
Constant Field Values

SENDER_ID_PROPERTY

public static final java.lang.String SENDER_ID_PROPERTY
Name of JMS message property that holds the message sender ID

See Also:
Constant Field Values

ASYNC_DELIVERY_MODE_DEFAULT

public static final java.lang.Integer ASYNC_DELIVERY_MODE_DEFAULT
This constant can be used with ConnectionFactory.setAsynchronousDeliveryMode(Integer). See that method's documentation for usage of this constant.


ASYNC_DELIVERY_MODE_ENABLED

public static final java.lang.Integer ASYNC_DELIVERY_MODE_ENABLED
This constant is used to specify asynchronous message delivery with ConnectionFactory.setAsynchronousDeliveryMode(Integer). See that method's documentation for usage of this constant.


ASYNC_DELIVERY_MODE_DISABLED

public static final java.lang.Integer ASYNC_DELIVERY_MODE_DISABLED
This constant is used to specify synchronous delivery mode with ConnectionFactory.setAsynchronousDeliveryMode(Integer). See that method's documentation for usage of this constant.

Constructor Detail

Constants

public Constants()

SonicMQ API

Copyright © 1999-2010 Progress Software Corporation. All Rights Reserved.
HTML formatted on 15-September-2010.