org.wso2.carbon.event.input.adapter.jms.internal.util

Class JMSConstants

java.lang.Object

org.wso2.carbon.event.input.adapter.jms.internal.util.JMSConstants

public class JMSConstants
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CACHE_AUTO automatic choice of an appropriate caching level (depending on the transaction strategy)
static int	CACHE_CONNECTION Cache only the JMS connection between tasks (when receiving), or JMS CF's (when sending)
static int	CACHE_CONSUMER Cache the JMS connection, Session and Consumer between tasks when receiving
static int	CACHE_NONE Do not cache any JMS resources between tasks (when sending) or JMS CF's (when sending)
static int	CACHE_PRODUCER Cache the JMS connection, Session and Producer within a JMSConnectionFactory when sending
static int	CACHE_SESSION Cache only the JMS connection and Session between tasks (receiving), or JMS CF's (sending)
static String	CONTENT_TYPE_PARAM The Parameter indicating the expected content type for messages received by the service.
static String	CONTENT_TYPE_PROPERTY_PARAM The EPR parameter name indicating the name of the message level property that indicated the content type.
static String	DEFAULT_CONFAC_NAME The local (Axis2) JMS connection factory name of the default connection factory to be used, if a service does not explicitly state the connection factory it should be using by a Parameter named JMSConstants.CONFAC_PARAM
static long	DEFAULT_JMS_TIMEOUT The default JMS time out waiting for a reply - also see JMS_WAIT_REPLY
static String	DESTINATION_TYPE_GENERIC Value indicating a JMS 1.1 Generic Destination used by DEST_PARAM_TYPE, REPLY_PARAM_TYPE
static String	DESTINATION_TYPE_QUEUE Value indicating a Queue used for DEST_PARAM_TYPE, REPLY_PARAM_TYPE
static String	DESTINATION_TYPE_TOPIC Value indicating a Topic used for DEST_PARAM_TYPE, REPLY_PARAM_TYPE
static int	GENERIC A JMS 1.1 Generic Destination type or ConnectionFactory
static String	JMS_BYTE_MESSAGE The message type indicating a BytesMessage.
static String	JMS_COORELATION_ID A MessageContext property or client Option indicating the JMS correlation id
static String	JMS_DELIVERY_MODE A MessageContext property or client Option indicating the JMS delivery mode as an Integer or String Value 1 - javax.jms.DeliveryMode.NON_PERSISTENT Value 2 - javax.jms.DeliveryMode.PERSISTENT
static String	JMS_DESTINATION A MessageContext property or client Option indicating the JMS destination to use on a Send
static String	JMS_EXPIRATION A MessageContext property or client Option indicating the JMS message expiration - a Long value specified as a String
static String	JMS_MAP_MESSAGE The message type indicating a TextMessage.
static String	JMS_MESSAGE_ID A MessageContext property or client Option indicating the JMS message id
static String	JMS_MESSAGE_TYPE A MessageContext property or client Option indicating the JMS message type
static String	JMS_PREFIX The prefix indicating an Axis JMS URL
static String	JMS_PRIORITY A MessageContext property or client Option indicating the JMS priority
static String	JMS_REDELIVERED A MessageContext property indicating if the message is a redelivery (Boolean as a String)
static String	JMS_REPLY_TO A MessageContext property or client Option indicating the JMS replyTo Destination
static String	JMS_REPLY_TO_TYPE A MessageContext property or client Option indicating the JMS replyTo Destination type See DESTINATION_TYPE_QUEUE and DESTINATION_TYPE_TOPIC
static String	JMS_TEXT_MESSAGE The message type indicating a TextMessage.
static String	JMS_TIME_TO_LIVE A MessageContext property or client Option indicating the JMS time to live for message sent
static String	JMS_TIMESTAMP A MessageContext property or client Option indicating the JMS timestamp (Long specified as String)
static String	JMS_TYPE A MessageContext property indicating the JMS type String returned by javax.jms.Message.getJMSType()
static String	JMS_WAIT_REPLY A MessageContext property or client Option indicating the time to wait for a response JMS message
static String	JMSX_GROUP_ID The JMSXGroupID property
static String	JMSX_GROUP_SEQ The JMSXGroupSeq property
static String	JMSX_PREFIX The prefix that denotes JMSX properties
static String	PARAM_CACHE_LEVEL JMS Resource cachable level to be used for the service One of the following: CACHE_NONE, CACHE_CONNECTION, CACHE_SESSION, CACHE_PRODUCER, CACHE_CONSUMER, or CACHE_AUTO - to let the transport decide
static String	PARAM_CONCURRENT_CONSUMERS The number of concurrent consumers to be created to poll for messages for this service For Topics, this should be ONE, to prevent receipt of multiple copies of the same message
static String	PARAM_CONFAC_JNDI_NAME The Parameter name indicating the JMS connection factory JNDI name
static String	PARAM_CONFAC_TYPE Connection factory type if using JMS 1.0, either DESTINATION_TYPE_QUEUE or DESTINATION_TYPE_TOPIC
static String	PARAM_DEST_TYPE The Service level Parameter name indicating the destination type for requests.
static String	PARAM_DESTINATION The Service level Parameter name indicating the JMS destination for requests of a service
static String	PARAM_DURABLE_SUB_CLIENT_ID
static String	PARAM_DURABLE_SUB_NAME The name for the durable subscription See PARAM_SUB_DURABLE
static String	PARAM_IDLE_TASK_LIMIT The number of idle (i.e.
static String	PARAM_JMS_CONFAC The Parameter name of an Axis2 service, indicating the JMS connection factory which should be used to listen for messages for it.
static String	PARAM_JMS_PASSWORD The password to use when obtaining a JMS Connection
static String	PARAM_JMS_SPEC_VER The parameter indicating the JMS API specification to be used - if this is "1.1" the JMS 1.1 API would be used, else the JMS 1.0.2B
static String	PARAM_JMS_USERNAME The username to use when obtaining a JMS Connection
static String	PARAM_MAX_CONSUMERS The maximum number of concurrent consumers for the service - See PARAM_CONCURRENT_CONSUMERS
static String	PARAM_MAX_MSGS_PER_TASK The maximum number of messages a polling worker task should process, before suicide - to prevent many longer running threads - default is unlimited (i.e.
static String	PARAM_MSG_SELECTOR A message selector to be used when messages are sought for this service
static String	PARAM_PUBLISH_EPR The Parameter indicating a final EPR as a String, to be published on the WSDL of a service Could occur more than once, and could provide additional connection properties or a subset of the properties auto computed.
static String	PARAM_PUBSUB_NO_LOCAL Should a pub-sub connection receive messages published by itself?
static String	PARAM_RCV_TIMEOUT The number of milliseconds to wait for a message on a consumer.receive() call negative number - wait forever 0 - do not wait at all positive number - indicates the number of milliseconds to wait
static String	PARAM_RECON_FACTOR
static String	PARAM_RECON_INIT_DURATION Number of milliseconds before the first reconnection attempt is tried, on detection of an error.
static String	PARAM_RECON_MAX_DURATION
static String	PARAM_REPLY_DEST_TYPE The Service level Parameter name indicating the response destination type also see DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_TOPIC
static String	PARAM_REPLY_DESTINATION The Service level Parameter name indicating the [default] response destination of a service
static String	PARAM_SESSION_ACK The Parameter indicating the Session acknowledgement for the service.
static String	PARAM_SESSION_TRANSACTED The Parameter indicating whether the JMS Session should be transacted for the service Specified as a "true" or "false"
static String	PARAM_SUB_DURABLE Is the Subscription durable ? - "true" or "false" See PARAM_DURABLE_SUB_NAME
static int	QUEUE A Queue Destination type or ConnectionFactory
static int	TOPIC A Topic Destination type or ConnectionFactory

Constructor Summary

Constructors

Constructor and Description
JMSConstants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JMS_PREFIX

public static final String JMS_PREFIX

The prefix indicating an Axis JMS URL

See Also:

Constant Field Values

DEFAULT_CONFAC_NAME

public static final String DEFAULT_CONFAC_NAME

The local (Axis2) JMS connection factory name of the default connection factory to be used, if a service does not explicitly state the connection factory it should be using by a Parameter named JMSConstants.CONFAC_PARAM

See Also:

Constant Field Values

DEFAULT_JMS_TIMEOUT

public static final long DEFAULT_JMS_TIMEOUT

The default JMS time out waiting for a reply - also see JMS_WAIT_REPLY

See Also:

Constant Field Values

DESTINATION_TYPE_QUEUE

public static final String DESTINATION_TYPE_QUEUE

Value indicating a Queue used for DEST_PARAM_TYPE, REPLY_PARAM_TYPE

See Also:

Constant Field Values

DESTINATION_TYPE_TOPIC

public static final String DESTINATION_TYPE_TOPIC

Value indicating a Topic used for DEST_PARAM_TYPE, REPLY_PARAM_TYPE

See Also:

Constant Field Values

DESTINATION_TYPE_GENERIC

public static final String DESTINATION_TYPE_GENERIC

Value indicating a JMS 1.1 Generic Destination used by DEST_PARAM_TYPE, REPLY_PARAM_TYPE

See Also:

Constant Field Values

CACHE_NONE

public static final int CACHE_NONE

Do not cache any JMS resources between tasks (when sending) or JMS CF's (when sending)

See Also:

Constant Field Values

CACHE_CONNECTION

public static final int CACHE_CONNECTION

Cache only the JMS connection between tasks (when receiving), or JMS CF's (when sending)

See Also:

Constant Field Values

CACHE_SESSION

public static final int CACHE_SESSION

Cache only the JMS connection and Session between tasks (receiving), or JMS CF's (sending)

See Also:

Constant Field Values

CACHE_CONSUMER

public static final int CACHE_CONSUMER

Cache the JMS connection, Session and Consumer between tasks when receiving

See Also:

Constant Field Values

CACHE_PRODUCER

public static final int CACHE_PRODUCER

Cache the JMS connection, Session and Producer within a JMSConnectionFactory when sending

See Also:

Constant Field Values

CACHE_AUTO

public static final int CACHE_AUTO

automatic choice of an appropriate caching level (depending on the transaction strategy)

See Also:

Constant Field Values

GENERIC

public static final int GENERIC

A JMS 1.1 Generic Destination type or ConnectionFactory

See Also:

Constant Field Values

QUEUE

public static final int QUEUE

A Queue Destination type or ConnectionFactory

See Also:

Constant Field Values

TOPIC

public static final int TOPIC

A Topic Destination type or ConnectionFactory

See Also:

Constant Field Values

CONTENT_TYPE_PROPERTY_PARAM

public static final String CONTENT_TYPE_PROPERTY_PARAM

The EPR parameter name indicating the name of the message level property that indicated the content type.

See Also:

Constant Field Values

PARAM_DESTINATION

public static final String PARAM_DESTINATION

The Service level Parameter name indicating the JMS destination for requests of a service

See Also:

Constant Field Values

PARAM_DEST_TYPE

public static final String PARAM_DEST_TYPE

The Service level Parameter name indicating the destination type for requests. also see DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_TOPIC

See Also:

Constant Field Values

PARAM_REPLY_DESTINATION

public static final String PARAM_REPLY_DESTINATION

The Service level Parameter name indicating the [default] response destination of a service

See Also:

Constant Field Values

PARAM_REPLY_DEST_TYPE

public static final String PARAM_REPLY_DEST_TYPE

The Service level Parameter name indicating the response destination type also see DESTINATION_TYPE_QUEUE, DESTINATION_TYPE_TOPIC

See Also:

Constant Field Values

PARAM_JMS_CONFAC

public static final String PARAM_JMS_CONFAC

The Parameter name of an Axis2 service, indicating the JMS connection factory which should be used to listen for messages for it. This is the local (Axis2) name of the connection factory and not the JNDI name

See Also:

Constant Field Values

PARAM_CONFAC_TYPE

public static final String PARAM_CONFAC_TYPE

Connection factory type if using JMS 1.0, either DESTINATION_TYPE_QUEUE or DESTINATION_TYPE_TOPIC

See Also:

Constant Field Values

PARAM_CONFAC_JNDI_NAME

public static final String PARAM_CONFAC_JNDI_NAME

The Parameter name indicating the JMS connection factory JNDI name

See Also:

Constant Field Values

CONTENT_TYPE_PARAM

public static final String CONTENT_TYPE_PARAM

The Parameter indicating the expected content type for messages received by the service.

See Also:

Constant Field Values

PARAM_PUBLISH_EPR

public static final String PARAM_PUBLISH_EPR

The Parameter indicating a final EPR as a String, to be published on the WSDL of a service Could occur more than once, and could provide additional connection properties or a subset of the properties auto computed. Also could replace IP addresses with hostnames, and expose public credentials clients. If a user specified this parameter, the auto generated EPR will not be exposed - unless an instance of this parameter is added with the string "legacy" This parameter could be used to expose EPR's conforming to the proposed SOAP/JMS spec until such time full support is implemented for it.

See Also:

Constant Field Values

PARAM_JMS_SPEC_VER

public static final String PARAM_JMS_SPEC_VER

The parameter indicating the JMS API specification to be used - if this is "1.1" the JMS 1.1 API would be used, else the JMS 1.0.2B

See Also:

Constant Field Values

PARAM_SESSION_TRANSACTED

public static final String PARAM_SESSION_TRANSACTED

The Parameter indicating whether the JMS Session should be transacted for the service Specified as a "true" or "false"

See Also:

Constant Field Values

PARAM_SESSION_ACK

public static final String PARAM_SESSION_ACK

The Parameter indicating the Session acknowledgement for the service. Must be one of the following Strings, or the appropriate Integer used by the JMS API "AUTO_ACKNOWLEDGE", "CLIENT_ACKNOWLEDGE", "DUPS_OK_ACKNOWLEDGE" or "SESSION_TRANSACTED"

See Also:

Constant Field Values

PARAM_MSG_SELECTOR

public static final String PARAM_MSG_SELECTOR

A message selector to be used when messages are sought for this service

See Also:

Constant Field Values

PARAM_SUB_DURABLE

public static final String PARAM_SUB_DURABLE

Is the Subscription durable ? - "true" or "false" See PARAM_DURABLE_SUB_NAME

See Also:

Constant Field Values

PARAM_DURABLE_SUB_NAME

public static final String PARAM_DURABLE_SUB_NAME

The name for the durable subscription See PARAM_SUB_DURABLE

See Also:

Constant Field Values

PARAM_CACHE_LEVEL

public static final String PARAM_CACHE_LEVEL

JMS Resource cachable level to be used for the service One of the following: CACHE_NONE, CACHE_CONNECTION, CACHE_SESSION, CACHE_PRODUCER, CACHE_CONSUMER, or CACHE_AUTO - to let the transport decide

See Also:

Constant Field Values

PARAM_PUBSUB_NO_LOCAL

public static final String PARAM_PUBSUB_NO_LOCAL

Should a pub-sub connection receive messages published by itself?

See Also:

Constant Field Values

PARAM_RCV_TIMEOUT

public static final String PARAM_RCV_TIMEOUT

The number of milliseconds to wait for a message on a consumer.receive() call negative number - wait forever 0 - do not wait at all positive number - indicates the number of milliseconds to wait

See Also:

Constant Field Values

PARAM_CONCURRENT_CONSUMERS

public static final String PARAM_CONCURRENT_CONSUMERS

The number of concurrent consumers to be created to poll for messages for this service For Topics, this should be ONE, to prevent receipt of multiple copies of the same message

See Also:

Constant Field Values

PARAM_MAX_CONSUMERS

public static final String PARAM_MAX_CONSUMERS

The maximum number of concurrent consumers for the service - See PARAM_CONCURRENT_CONSUMERS

See Also:

Constant Field Values

PARAM_IDLE_TASK_LIMIT

public static final String PARAM_IDLE_TASK_LIMIT

The number of idle (i.e. message-less) polling attempts before a worker task commits suicide, to scale down resources, as load decreases

See Also:

Constant Field Values

PARAM_MAX_MSGS_PER_TASK

public static final String PARAM_MAX_MSGS_PER_TASK

The maximum number of messages a polling worker task should process, before suicide - to prevent many longer running threads - default is unlimited (i.e. a worker task will live forever)

See Also:

Constant Field Values

PARAM_RECON_INIT_DURATION

public static final String PARAM_RECON_INIT_DURATION

Number of milliseconds before the first reconnection attempt is tried, on detection of an error. Subsequent retries follow a geometric series, where the duration = previous duration * factor This is further limited by the PARAM_RECON_MAX_DURATION to be meaningful

See Also:

Constant Field Values

PARAM_RECON_FACTOR

public static final String PARAM_RECON_FACTOR

See Also:

PARAM_RECON_INIT_DURATION, Constant Field Values

PARAM_RECON_MAX_DURATION

public static final String PARAM_RECON_MAX_DURATION

See Also:

PARAM_RECON_INIT_DURATION, Constant Field Values

PARAM_JMS_USERNAME

public static final String PARAM_JMS_USERNAME

The username to use when obtaining a JMS Connection

See Also:

Constant Field Values

PARAM_JMS_PASSWORD

public static final String PARAM_JMS_PASSWORD

The password to use when obtaining a JMS Connection

See Also:

Constant Field Values

PARAM_DURABLE_SUB_CLIENT_ID

public static final String PARAM_DURABLE_SUB_CLIENT_ID

See Also:

Constant Field Values

JMS_MESSAGE_TYPE

public static final String JMS_MESSAGE_TYPE

A MessageContext property or client Option indicating the JMS message type

See Also:

Constant Field Values

JMS_BYTE_MESSAGE

public static final String JMS_BYTE_MESSAGE

The message type indicating a BytesMessage. See JMS_MESSAGE_TYPE

See Also:

Constant Field Values

JMS_TEXT_MESSAGE

public static final String JMS_TEXT_MESSAGE

The message type indicating a TextMessage. See JMS_MESSAGE_TYPE

See Also:

Constant Field Values

JMS_MAP_MESSAGE

public static final String JMS_MAP_MESSAGE

The message type indicating a TextMessage. See JMS_MESSAGE_TYPE

See Also:

Constant Field Values

JMS_WAIT_REPLY

public static final String JMS_WAIT_REPLY

A MessageContext property or client Option indicating the time to wait for a response JMS message

See Also:

Constant Field Values

JMS_COORELATION_ID

public static final String JMS_COORELATION_ID

A MessageContext property or client Option indicating the JMS correlation id

See Also:

Constant Field Values

JMS_MESSAGE_ID

public static final String JMS_MESSAGE_ID

A MessageContext property or client Option indicating the JMS message id

See Also:

Constant Field Values

JMS_DELIVERY_MODE

public static final String JMS_DELIVERY_MODE

A MessageContext property or client Option indicating the JMS delivery mode as an Integer or String Value 1 - javax.jms.DeliveryMode.NON_PERSISTENT Value 2 - javax.jms.DeliveryMode.PERSISTENT

See Also:

Constant Field Values

JMS_DESTINATION

public static final String JMS_DESTINATION

A MessageContext property or client Option indicating the JMS destination to use on a Send

See Also:

Constant Field Values

JMS_EXPIRATION

public static final String JMS_EXPIRATION

A MessageContext property or client Option indicating the JMS message expiration - a Long value specified as a String

See Also:

Constant Field Values

JMS_REDELIVERED

public static final String JMS_REDELIVERED

A MessageContext property indicating if the message is a redelivery (Boolean as a String)

See Also:

Constant Field Values

JMS_REPLY_TO

public static final String JMS_REPLY_TO

A MessageContext property or client Option indicating the JMS replyTo Destination

See Also:

Constant Field Values

JMS_REPLY_TO_TYPE

public static final String JMS_REPLY_TO_TYPE

A MessageContext property or client Option indicating the JMS replyTo Destination type See DESTINATION_TYPE_QUEUE and DESTINATION_TYPE_TOPIC

See Also:

Constant Field Values

JMS_TIMESTAMP

public static final String JMS_TIMESTAMP

A MessageContext property or client Option indicating the JMS timestamp (Long specified as String)

See Also:

Constant Field Values

JMS_TYPE

public static final String JMS_TYPE

A MessageContext property indicating the JMS type String returned by javax.jms.Message.getJMSType()

See Also:

Constant Field Values

JMS_PRIORITY

public static final String JMS_PRIORITY

A MessageContext property or client Option indicating the JMS priority

See Also:

Constant Field Values

JMS_TIME_TO_LIVE

public static final String JMS_TIME_TO_LIVE

A MessageContext property or client Option indicating the JMS time to live for message sent

See Also:

Constant Field Values

JMSX_PREFIX

public static final String JMSX_PREFIX

The prefix that denotes JMSX properties

See Also:

Constant Field Values

JMSX_GROUP_ID

public static final String JMSX_GROUP_ID

The JMSXGroupID property

See Also:

Constant Field Values

JMSX_GROUP_SEQ

public static final String JMSX_GROUP_SEQ

The JMSXGroupSeq property

See Also:

Constant Field Values

Constructor Detail

JMSConstants

public JMSConstants()