|
Message Queue, v4.4 API Specification | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.messaging.ConnectionConfiguration
public class ConnectionConfiguration
The ConnectionConfiguration
class contains Sun MQ specific connection
configuration property names and special values.
com.sun.messaging.ConnectionFactory
Field Summary | |
---|---|
static java.lang.String |
imqAckOnAcknowledge
This property is used to control the reliability of message acknowledgement for every message that is consumed by a MessageConsumer. |
static java.lang.String |
imqAckOnProduce
This property is used to control the reliability of every message that is produced by a MessageProducer. |
static java.lang.String |
imqAckTimeout
This property holds the the maximum time, in milliseconds, that a Sun MQ Client Application will wait before throwing a JMSException when awaiting an acknowledgement from the Sun MQ Message Service. |
static java.lang.String |
imqAddressList
This property holds the address list that will be used to connect to the Sun MQ Message Service. |
static java.lang.String |
imqAddressListBehavior
This property determines how Sun MQ will select entries from the imqAddressList property to use when making a connection
to the Sun MQ Message Service. |
static java.lang.String |
imqAddressListIterations
This property holds the number of times that Sun MQ will iterate through imqAddressList when connecting to the
Sun Message Queue Service. |
static java.lang.String |
imqBrokerHostName
This property holds the hostname that will be used to connect to the Sun MQ Message Service using the TCP and TLS ConnectionHandler classes provided with Sun MQ. |
static java.lang.String |
imqBrokerHostPort
This property holds the Primary Port number that will be used to connect to the Sun MQ Message Service using the TCP and TLS ConnectionHandler classes provided with Sun MQ. |
static java.lang.String |
imqBrokerServiceName
This property holds the connection service name that will be used to connect to the Sun MQ Message Service using the TCP and TLS ConnectionHandler classes provided with Sun MQ. |
static java.lang.String |
imqBrokerServicePort
This property holds the actual port number that will be used to connect to the Sun MQ Message Service using the TCP and TLS ConnectionHandler classes provided with Sun MQ. |
static java.lang.String |
imqConfiguredClientID
This property holds the value of an administratively configured ClientID. |
static java.lang.String |
imqConnectionFlowCount
This property manages the number of JMS messages that will flow from the Sun MQ Message Service to the MQ Client between each 'resume flow' notification from the Client to the Message Service to receive additional JMS messages. |
static java.lang.String |
imqConnectionFlowLimit
This property specifies the number of uncomsumed JMS messages that a Sun MQ Client can hold, above which the MQ Client will refrain from sending a 'resume flow' notification to the Sun MQ Message Service. |
static java.lang.String |
imqConnectionFlowLimitEnabled
This property indicates whether the Sun MQ Client should limit the flow of JMS messages from the Sun MQ Message Service using the number of messages specified in imqConnectionFlowLimit . |
static java.lang.String |
imqConnectionHandler
This property holds the name of the class that will be used to handle the connection to the Sun MQ Message Service and is required when the value of the imqConnectionType property is set to ... |
static java.lang.String |
imqConnectionType
This property holds the connection type used to connect to the Sun MQ Message Service. |
static java.lang.String |
imqConnectionURL
This property holds the URL that will be used when connecting to the Sun MQ Message Service using the HTTP ConnectionHandler class provided with Sun MQ. |
static java.lang.String |
imqConsumerFlowLimit
This property specifies the upper limit of the number of messages per consumer that will be delivered and buffered in the MQ client. |
static java.lang.String |
imqConsumerFlowThreshold
This property controls when JMS message delivery will resume to consumers that have had their message delivery stopped due to the number of messages buffered in the MQ client exceeding the limit set by imqConsumerFlowLimit and is expressed as a percentage of
imqConsumerFlowLimit . |
static java.lang.String |
imqDefaultPassword
This property holds the default password that will be used to authenticate with the Sun MQ Message Service. |
static java.lang.String |
imqDefaultUsername
This property holds the default username that will be used to authenticate with the Sun MQ Message Service. |
static java.lang.String |
imqDisableSetClientID
This property indicates whether the Sun MQ Client Application is prevented from changing the ClientID using the setClientID()
method in javax.jms.Connection . |
static java.lang.String |
imqEnableSharedClientID
This property indicates whether the client identifier requested and used by this connection is to be acquired in 'shared' mode. |
static java.lang.String |
imqFlowControlCount
Deprecated. |
static java.lang.String |
imqFlowControlIsLimited
Deprecated. |
static java.lang.String |
imqFlowControlLimit
Deprecated. |
static java.lang.String |
imqJMSDeliveryMode
This property holds the administratively configured value of the JMS Message Header JMSDeliveryMode . |
static java.lang.String |
imqJMSExpiration
This property holds the administratively configured value of the JMS Message Header JMSExpiration . |
static java.lang.String |
imqJMSPriority
This property holds the administratively configured value of the JMS Message Header JMSPriority . |
static java.lang.String |
imqLoadMaxToServerSession
This property indicates how the Sun MQ ConnectionConsumer should load messages into a ServerSession's JMS Session. |
static java.lang.String |
imqOverrideJMSDeliveryMode
This property indicates whether Sun MQ should override the JMS Message Header JMSDeliveryMode which can be set using the JMS APIs. |
static java.lang.String |
imqOverrideJMSExpiration
This property indicates whether Sun MQ should override the JMS Message Header JMSExpiration which can be set using the JMS APIs. |
static java.lang.String |
imqOverrideJMSHeadersToTemporaryDestinations
This property indicates whether Sun MQ should override the JMS Message Headers on Messages that are sent to Temporary Destinations. |
static java.lang.String |
imqOverrideJMSPriority
This property indicates whether Sun MQ should override the JMS Message Header JMSPriority which can be set using the JMS APIs. |
static java.lang.String |
imqPingInterval
This property specifies the 'ping' interval, in seconds, between successive attempts made by an MQ Connection to verify that its physical connection to the MQ broker is still functioning properly. |
static java.lang.String |
imqQueueBrowserMaxMessagesPerRetrieve
This property holds the the maximum number of messages that will be retrieved at one time when a Sun MQ Client Application is enumerating through the messages on a Queue using a QueueBrowser. |
static java.lang.String |
imqQueueBrowserRetrieveTimeout
This property holds the the maximum time, in milliseconds, that a Sun MQ Client Application will wait before throwing a NoSuchElementException when retrieving elements from a QueueBrowser Enumeration. |
static java.lang.String |
imqReconnect
Deprecated. |
static java.lang.String |
imqReconnectAttempts
This property holds the number of reconnect attempts for each address in the imqAddressList property that the Sun MQ Client
Application will make before moving on the the next address in imqAddressList . |
static java.lang.String |
imqReconnectDelay
Deprecated. |
static java.lang.String |
imqReconnectEnabled
This property indicates whether the Sun MQ Client Application will attempt to reconnect to the Sun MQ Message Service upon losing its connection. |
static java.lang.String |
imqReconnectInterval
This property specifies the interval, in milliseconds, between successive reconnect attempts made by the MQ Client Application to the Sun MQ Message Service. |
static java.lang.String |
imqReconnectRetries
Deprecated. |
static java.lang.String |
imqSetJMSXAppID
This property indicates whether Sun MQ should set the JMSXAppID property on produced messages. |
static java.lang.String |
imqSetJMSXConsumerTXID
This property indicates whether Sun MQ should set the JMSXConsumerTXID property on consumed messages. |
static java.lang.String |
imqSetJMSXProducerTXID
This property indicates whether Sun MQ should set the JMSXProducerTXID property on produced messages. |
static java.lang.String |
imqSetJMSXRcvTimestamp
This property indicates whether Sun MQ should set the JMSXRcvTimestamp property on consumed messages. |
static java.lang.String |
imqSetJMSXUserID
This property indicates whether Sun MQ should set the JMSXUserID property on produced messages. |
static java.lang.String |
imqSSLIsHostTrusted
This property indicates whether the host is trusted when connecting to the Sun MQ Message Service using the TLS ConnectionHandler class provided with Sun MQ. |
static java.lang.String |
imqSSLProviderClassname
This property holds the TLS Provider Classname that will be used when connecting to the Sun MQ Message Service using the TLS ConnectionHandler class provided with Sun MQ. |
static java.lang.String |
JMQAckOnAcknowledge
Deprecated. |
static java.lang.String |
JMQAckOnProduce
Deprecated. |
static java.lang.String |
JMQAckTimeout
Deprecated. |
static java.lang.String |
JMQBrokerHostName
Deprecated. |
static java.lang.String |
JMQBrokerHostPort
Deprecated. |
static java.lang.String |
JMQBrokerServiceName
Deprecated. |
static java.lang.String |
JMQBrokerServicePort
Deprecated. |
static java.lang.String |
JMQConfiguredClientID
Deprecated. |
static java.lang.String |
JMQConnectionHandler
Deprecated. |
static java.lang.String |
JMQConnectionType
Deprecated. |
static java.lang.String |
JMQConnectionURL
Deprecated. |
static java.lang.String |
JMQConsumerFlowThreshold
Deprecated. |
static java.lang.String |
JMQDefaultPassword
Deprecated. |
static java.lang.String |
JMQDefaultUsername
Deprecated. |
static java.lang.String |
JMQDisableSetClientID
Deprecated. |
static java.lang.String |
JMQEnableSharedClientID
Deprecated. |
static java.lang.String |
JMQFlowControlCount
Deprecated. |
static java.lang.String |
JMQFlowControlIsLimited
Deprecated. |
static java.lang.String |
JMQFlowControlLimit
Deprecated. |
static java.lang.String |
JMQJMSDeliveryMode
Deprecated. |
static java.lang.String |
JMQJMSExpiration
Deprecated. |
static java.lang.String |
JMQJMSPriority
Deprecated. |
static java.lang.String |
JMQLoadMaxToServerSession
Deprecated. |
static java.lang.String |
JMQOverrideJMSDeliveryMode
Deprecated. |
static java.lang.String |
JMQOverrideJMSExpiration
Deprecated. |
static java.lang.String |
JMQOverrideJMSHeadersToTemporaryDestinations
Deprecated. |
static java.lang.String |
JMQOverrideJMSPriority
Deprecated. |
static java.lang.String |
JMQPrefetchMaxMsgCount
Deprecated. |
static java.lang.String |
JMQQueueBrowserMaxMessagesPerRetrieve
Deprecated. |
static java.lang.String |
JMQQueueBrowserRetrieveTimeout
Deprecated. |
static java.lang.String |
JMQReconnect
Deprecated. |
static java.lang.String |
JMQReconnectDelay
Deprecated. |
static java.lang.String |
JMQReconnectRetries
Deprecated. |
static java.lang.String |
JMQSetJMSXAppID
Deprecated. |
static java.lang.String |
JMQSetJMSXConsumerTXID
Deprecated. |
static java.lang.String |
JMQSetJMSXProducerTXID
Deprecated. |
static java.lang.String |
JMQSetJMSXRcvTimestamp
Deprecated. |
static java.lang.String |
JMQSetJMSXUserID
Deprecated. |
static java.lang.String |
JMQSSLIsHostTrusted
Deprecated. |
static java.lang.String |
JMQSSLProviderClassname
Deprecated. |
static java.lang.String |
JMSDeliveryMode_NON_PERSISTENT
This constant is used to set the value of imqJMSDeliveryMode
to NON_PERSISTENT when the JMSDeliveryMode JMS Message Header
is administratively configured. |
static java.lang.String |
JMSDeliveryMode_PERSISTENT
This constant is used to set the value of imqJMSDeliveryMode
to PERSISTENT when the JMSDeliveryMode JMS Message Header
is administratively configured. |
Method Summary |
---|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String imqAddressList
Message Server Address Syntax
The syntax for specifying a message server address is as follows:
scheme://address_syntax
where the scheme
and address_syntax
are described in the folowing
table.
Scheme | Connection Service | Description | Syntax |
---|---|---|---|
mq |
jms
|
The MQ Port Mapper at the specified host and port will handle the connection request, dynamically assigning a port based on the specified connection service. Once the port number is known, MQ makes the connection. | [hostName][:port][/serviceName] Defaults (for jms service only): hostName = localhost |
mqtcp |
jms |
MQ makes a direct tcp connection to the specified host and port to establish a connection. | hostName:port/jms |
mqssl |
ssljms |
MQ makes a direct, secure ssl connection to the specified host and port to establish a connection. | hostName:port/ssljms |
htttp |
httpjms |
MQ makes a direct HTTP connection to the specified MQ tunnel servlet URL. (The broker must be configured to access the tunnel servlet.) | HTTPtunnelServletURL |
htttps |
httpsjms |
MQ makes a direct HTTPS connection to the specified MQ tunnel servlet URL. (The broker must be configured to access the tunnel servlet.) | HTTPStunnelServletURL |
The following table shows how the message server address syntax applies in some typical cases.
Connection Service | Broker Host | Port | Example Address |
---|---|---|---|
Unspecified | Unspecified | Unspecified | Default(mq://localHost:7676/jms) |
Unspecified | Specified Host | Unspecified | myBkrHost |
Unspecified | Unspecified | Specified Portmapper Port | 1012 |
ssljms |
Local Host | Default Portmapper Port | mq://localHost:7676/ssljms |
ssljms |
Specified Host | Default Portmapper Port | mq://myBkrHost:7676/ssljms |
ssljms |
Specified Host | Specified Portmapper Port | mq://myBkrHost:1012/ssljms |
jms |
Local Host | Specified Service Port | mqtcp://localhost:1032/jms |
ssljms |
Specified Host | Specified Service Port | mqssl://myBkrHost:1034/ssljms |
httpjms |
N/A | N/A | http://websrvr1:8085/imq/tunnel |
httpsjms |
N/A | N/A | https://websrvr2:8090/imq/tunnel |
The default value of this property is empty
imqAddressListBehavior
,
imqAddressListIterations
,
Constant Field Valuespublic static final java.lang.String imqAddressListIterations
imqAddressList
when connecting to the
Sun Message Queue Service.
The default value of this property is 1
imqAddressList
,
imqAddressListBehavior
,
Constant Field Valuespublic static final java.lang.String imqAddressListBehavior
imqAddressList
property to use when making a connection
to the Sun MQ Message Service.
The acceptable values for this property are PRIORITY
and
RANDOM
.
When PRIORITY
is used, Sun MQ will start with the
firstentry in imqAddressList
when attempting
to make the first connection to the Sun MQ Message Service.
Subsequently, when Sun MQ is attempting to re-connect to the Message
Service, it will use successive entries from imqAddressList
in the order they are specified.
When RANDOM
is used, Sun MQ will start with a
random entry in imqAddressList
when attempting
to make the first connection to the Sun MQ Message Service.
Subsequently, when Sun MQ is attempting to re-connect to the Message
Service, it will use entries in the order they are specified in
imqAddressList
starting with the initial
randomly chosen entry.
The default value of this property is PRIORITY
imqAddressList
,
imqAddressListIterations
,
Constant Field Valuespublic static final java.lang.String imqConnectionType
Note that this property is superseded by the imqAddressList
property
and is present only for compatibility with MQ 3.0 clients. This property may be removed in
the next major version of MQ.
The default value of this property is TCP
The allowable values are TCP,TLS,HTTP,and the special value - ...
When the special value of ...
is used, the classname specified in the property
imqConnectionHandler
is required to handle the connection to the Sun MQ Message Service.
imqAddressList
,
Constant Field Valuespublic static final java.lang.String JMQConnectionType
imqConnectionType
,
Constant Field Valuespublic static final java.lang.String imqConnectionHandler
imqConnectionType
property is set to ...
This property is not normally specified and will assume the classname handling the ConnectionType
specified in imqConnectionType
. However, if specified, this property
overrides imqConnectionType
.
The default value of this property is com.sun.messaging.jmq.jmsclient.protocol.tcp.TCPStreamHandler
public static final java.lang.String JMQConnectionHandler
imqConnectionHandler
,
Constant Field Valuespublic static final java.lang.String imqDefaultUsername
The default value of this property is guest
public static final java.lang.String JMQDefaultUsername
imqDefaultUsername
,
Constant Field Valuespublic static final java.lang.String imqDefaultPassword
The default value of this property is guest
public static final java.lang.String JMQDefaultPassword
imqDefaultPassword
,
Constant Field Valuespublic static final java.lang.String imqAckTimeout
A value of 0
indicates that it will wait indefinitely.
The default value for this property is 0
i.e. indefinitely.
public static final java.lang.String JMQAckTimeout
imqAckTimeout
,
Constant Field Valuespublic static final java.lang.String imqReconnectEnabled
The default value for this property is false
public static final java.lang.String imqReconnect
imqReconnectEnabled
,
Constant Field Valuespublic static final java.lang.String JMQReconnect
imqReconnectEnabled
,
Constant Field Valuespublic static final java.lang.String imqReconnectInterval
The default value for this property is 30000
milliseconds.
public static final java.lang.String imqReconnectDelay
imqReconnectInterval
,
Constant Field Valuespublic static final java.lang.String JMQReconnectDelay
imqReconnectInterval
,
Constant Field Valuespublic static final java.lang.String imqReconnectAttempts
imqAddressList
property that the Sun MQ Client
Application will make before moving on the the next address in imqAddressList
.
will make in trying to reconnect to the Sun MQ Message Service.
A value of -1
indicates that the MQ Client Application will
make an unlimited number of reconnect attempts.
Note that this property is only applicable when imqReconnectEnabled
is
set to true
.
The default value for this property is 0
- i.e. No reconnect attempts.
public static final java.lang.String imqReconnectRetries
imqReconnectAttempts
,
Constant Field Valuespublic static final java.lang.String JMQReconnectRetries
imqReconnectAttempts
,
Constant Field Valuespublic static final java.lang.String imqPingInterval
0
, or -1
indicates that the MQ Connection will disable this 'ping' functionality.
The default value for this property is 30
- i.e. 30 seconds between 'pings'.
public static final java.lang.String imqSetJMSXAppID
The default value of this property is false
public static final java.lang.String JMQSetJMSXAppID
imqSetJMSXAppID
,
Constant Field Valuespublic static final java.lang.String imqSetJMSXUserID
The default value of this property is false
public static final java.lang.String JMQSetJMSXUserID
imqSetJMSXUserID
,
Constant Field Valuespublic static final java.lang.String imqSetJMSXProducerTXID
The default value of this property is false
public static final java.lang.String JMQSetJMSXProducerTXID
imqSetJMSXProducerTXID
,
Constant Field Valuespublic static final java.lang.String imqSetJMSXConsumerTXID
The default value of this property is false
public static final java.lang.String JMQSetJMSXConsumerTXID
imqSetJMSXConsumerTXID
,
Constant Field Valuespublic static final java.lang.String imqSetJMSXRcvTimestamp
The default value of this property is false
public static final java.lang.String JMQSetJMSXRcvTimestamp
imqSetJMSXRcvTimestamp
,
Constant Field Valuespublic static final java.lang.String imqBrokerHostName
Note that this property is superseded by the imqAddressList
property
and is present only for compatibility with MQ 3.0 clients. This property may be removed in
the next major version of MQ.
The default value of this property is localhost
imqAddressList
,
Constant Field Valuespublic static final java.lang.String JMQBrokerHostName
imqBrokerHostName
,
Constant Field Valuespublic static final java.lang.String imqBrokerHostPort
Note that this property is superseded by the imqAddressList
property
and is present only for compatibility with MQ 3.0 clients. This property may be removed in
the next major version of MQ.
The Sun MQ Client uses this port to communicate with the Port Mapper Service to determine the actual port number of the connection service that it wishes to use.
The default value of this property is 7676
imqAddressList
,
Constant Field Valuespublic static final java.lang.String JMQBrokerHostPort
imqBrokerHostPort
,
Constant Field Valuespublic static final java.lang.String imqBrokerServiceName
Note that this property is superseded by the imqAddressList
property
and is present only for compatibility with MQ 3.0 clients. This property may be removed in
the next major version of MQ.
By default, when the value of this property is null
,
the MQ Client uses the Primary Port to connect to the
MQ Message Service and subsequently uses the first connection
service that corresponds to imqConnnectionType.
When the value of this property is non-null, the MQ Client will
first connect to the Port Mapper Service and then
use the connection service that matches imqBrokerServiceName
ensuring that it corresponds to the right imqConnectionType
.
The default value of this property is null
imqAddressList
,
Constant Field Valuespublic static final java.lang.String JMQBrokerServiceName
imqBrokerServiceName
,
Constant Field Valuespublic static final java.lang.String imqBrokerServicePort
Note that this property is superseded by the imqAddressList
property
and is present only for compatibility with MQ 3.0 clients. This property may be removed in
the next major version of MQ.
By default, when the value of this property is 0
,
the MQ Client uses the Primary Port to connect to the
MQ Message Service and subsequently determines the actual port
number of the connection service that it wishes to use.
When the value of this property is non-zero, the MQ Client will use this port number to directly connect to the connection service that it wishes to use without first communicating with the Port Mapper Service
The default value of this property is 0
imqAddressList
,
Constant Field Valuespublic static final java.lang.String JMQBrokerServicePort
imqBrokerServicePort
,
Constant Field Valuespublic static final java.lang.String imqSSLProviderClassname
The default value of this property is com.sun.net.ssl.internal.ssl.Provider
public static final java.lang.String JMQSSLProviderClassname
imqSSLProviderClassname
,
Constant Field Valuespublic static final java.lang.String imqSSLIsHostTrusted
If this value is set to false
, then the Root Certificate
provided by the Certificate Authority must be available
to the MQ Client Application when it connects to the
MQ Message Service.
The default value of this property is false
public static final java.lang.String JMQSSLIsHostTrusted
imqSSLIsHostTrusted
,
Constant Field Valuespublic static final java.lang.String imqConnectionURL
Note that this property is superseded by the imqAddressList
property
and is present only for compatibility with MQ 3.0 clients. This property may be removed in
the next major version of MQ.
Since the URL may be shared by multiple message service
instances, the optional ServerName
attribute can
be used to identify a specific message service address. The
ServerName
attribute is specified using the
standard query string syntax. For example -
http://localhost/imq/tunnel?ServerName=localhost:imqbroker
The default value of this property is http://localhost/imq/tunnel
imqAddressList
,
Constant Field Valuespublic static final java.lang.String JMQConnectionURL
imqConnectionURL
,
Constant Field Valuespublic static final java.lang.String imqDisableSetClientID
setClientID()
method in javax.jms.Connection
.
The default value of this property is false
imqConfiguredClientID
,
Connection.setClientID(clientID)
,
Connection.getClientID()
,
Constant Field Valuespublic static final java.lang.String JMQDisableSetClientID
imqDisableSetClientID
,
Constant Field Valuespublic static final java.lang.String imqConfiguredClientID
The default value of this property is null
imqDisableSetClientID
,
Connection.setClientID(clientID)
,
Connection.getClientID()
,
Constant Field Valuespublic static final java.lang.String JMQConfiguredClientID
imqConfiguredClientID
,
Constant Field Valuespublic static final java.lang.String imqEnableSharedClientID
When a client identifier is used in 'shared' mode, other connections are also allowed to use the same client identifier.
If a client identifier is already in use in 'unique' mode, then a request to set a client identifier in 'shared' mode will fail. Likewise, if a client identifier is already in use in 'shared' mode, then a request to set a client identifier in 'unique' mode will fail.
The default value of this property is false
- i.e.
a client identifier will be requested in 'unique' mode.
imqConfiguredClientID
,
imqDisableSetClientID
,
Connection.setClientID(clientID)
,
Connection.getClientID()
,
Constant Field Valuespublic static final java.lang.String JMQEnableSharedClientID
imqEnableSharedClientID
,
Constant Field Valuespublic static final java.lang.String imqAckOnProduce
The value of this property is used only when it is set. If the property is
left unset, (the default behavior), the Sun MQ Client will ensure that
every PERSISTENT message that is produced
has been received by the Sun MQ Message Service before returning from
the send()
and publish()
methods.
If this property is set to true
, then the MQ Client
will always wait until it ensures that the message has been
reecived by the MQ Message Service before returning from
the send()
and publish()
methods.
If this property is set to false
, then the MQ Client
will not wait until it ensures that the message has been
reecived by the MQ Message Service before returning from
the send()
and publish()
methods.
When this property is used, it applies to all messages and not just the PERSISTENT messages.
The value of this property is not set by default.
imqAckOnAcknowledge
,
Constant Field Valuespublic static final java.lang.String JMQAckOnProduce
imqAckOnProduce
,
Constant Field Valuespublic static final java.lang.String imqAckOnAcknowledge
The value of this property is used only when it is set. If the property is
left unset, (the default behavior), the Sun MQ Client will ensure that the
acknowledgment for every PERSISTENT message that is consumed, has been
received by the Sun MQ Message Service before the appropriate method returns -
i.e. either the Message.acknowledge()
method
in the CLIENT_ACKNOWLEDGE
mode or the
receive()
and/or onMessage()
methods in the
AUTO_ACKNOWLEDGE
and DUPS_OK_ACKNOWLEDGE
modes
and transacted Sessions.
If this property is set to true
, then the MQ Client
will always wait until it ensures that the acknowledgement for the message has been
reecived by the MQ Message Service before returning from
the send()
and publish()
methods.
If this property is set to false
, then the MQ Client
will not wait until it ensures that the acknowledgement for the message has been
reecived by the MQ Message Service before returning from
the appropriate method that is responsible for sending the acknowledgement -
i.e. either the Message.acknowledge()
method
in the CLIENT_ACKNOWLEDGE
mode or the
receive()
and/or onMessage()
methods in the
AUTO_ACKNOWLEDGE
and DUPS_OK_ACKNOWLEDGE
modes
and transacted Sessions.
The value of this property is not set by default.
imqAckOnProduce
,
Constant Field Valuespublic static final java.lang.String JMQAckOnAcknowledge
imqAckOnAcknowledge
,
Constant Field Valuespublic static final java.lang.String imqConsumerFlowLimit
imqConsumerFlowThreshold
property.
When a consumer is created, JMS messages for that consumer will begin
to flow to the connection on which the consumer has been established.
When the number of messages delivered to the consumer reaches the limit
set by imqConsumerFlowLimit
, delivery of messages is
stopped. As messages are consumed, the number of unconsumed messages
buffered in the MQ client drops.
When the number of unconsumed messages drops below
the number determined by using imqConsumerFlowThreshold
,
as a percentage of imqConsumerFlowLimit
, MQ resumes
delivery of messages to that consumer until the number of
messages delivered to that consumer reaches the limit set by
imqConsumerFlowLimit
.
Note that the actual value of the message flow limit used by MQ for each
consumer is the lower of two values - the imqConsumerFlowLimit
set on the ConnectionFactory and the consumerFlowLimit
value set on the physical destination that the consumer is established on.
The default value for this property is 1000
imqConsumerFlowThreshold
,
Constant Field Valuespublic static final java.lang.String JMQPrefetchMaxMsgCount
public static final java.lang.String imqConsumerFlowThreshold
imqConsumerFlowLimit
and is expressed as a percentage of
imqConsumerFlowLimit
.
See the description for the imqConsumerFlowLimit
property
for how the two properties are used together to meter the flow of
JMS messages to individual consumers.
The default value for this property is 50
(percent).
imqConsumerFlowLimit
,
Constant Field Valuespublic static final java.lang.String JMQConsumerFlowThreshold
public static final java.lang.String imqConnectionFlowCount
If the count is set to 0
then the Message Service will not restrict the number of JMS
messages sent to the Client.
After the Message Service has sent the number of JMS messages specified by this property, it will await a 'resume flow' notification from the Client before sending the next set of JMS messages. A non-zero value allows the Client to receive and process control messages from the Message Service even if there is a large number of JMS messages being held by the Message Service for delivery to this Client.
The MQ Client further has the ability to limit this JMS message flow
using the property imqConnectionFlowEnabled
The default value for this property is 100
imqConnectionFlowLimitEnabled
,
imqConnectionFlowLimit
,
Constant Field Valuespublic static final java.lang.String imqFlowControlCount
imqFlowControlCount
,
Constant Field Valuespublic static final java.lang.String JMQFlowControlCount
imqFlowControlCount
,
Constant Field Valuespublic static final java.lang.String imqConnectionFlowLimitEnabled
imqConnectionFlowLimit
.
This property will only be active if the property imqConnectionFlowCount
has been set to a non-zero value.
If this property is set to true
the Client will use the
property imqConnectionFlowLimit
as described below. Flow control
will not be limited if this property is set to false
.
The default value for this property is false
imqConnectionFlowCount
,
imqConnectionFlowLimit
,
Constant Field Valuespublic static final java.lang.String imqFlowControlIsLimited
imqConnectionFlowLimitEnabled
,
Constant Field Valuespublic static final java.lang.String JMQFlowControlIsLimited
imqConnectionFlowLimitEnabled
,
Constant Field Valuespublic static final java.lang.String imqConnectionFlowLimit
imqFlowControlEnabled
property is set to true
and the imqFlowControlCount
property is set to a non-zero value.
The MQ Client will notify the Sun MQ Message Service ('resume flow')
and receive JMS message (in chunks determined by imqFlowControlCount
)
until the number of received and uncomsumed JMS messages exceeds the value
of this property.
At this point, the Client will 'pause' until the JMS messages are consumed
and when the unconsumed JMS message count drops
below this value, the Client once again notifys the Message Service
and the flow of JMS messages to the Client is resumed.
The default value for this property is 1000
imqConnectionFlowLimitEnabled
,
imqConnectionFlowCount
,
Constant Field Valuespublic static final java.lang.String imqFlowControlLimit
imqConnectionFlowLimit
,
Constant Field Valuespublic static final java.lang.String JMQFlowControlLimit
imqConnectionFlowLimit
,
Constant Field Valuespublic static final java.lang.String imqQueueBrowserRetrieveTimeout
The default value for this property is 60000
milliseconds.
Enumeration
,
Enumeration.nextElement()
,
NoSuchElementException
,
javax.jms.QueueBrowser
,
Constant Field Valuespublic static final java.lang.String JMQQueueBrowserRetrieveTimeout
imqQueueBrowserRetrieveTimeout
,
Constant Field Valuespublic static final java.lang.String imqQueueBrowserMaxMessagesPerRetrieve
The default value for this property is 1000
Enumeration
,
Enumeration.nextElement()
,
javax.jms.QueueBrowser
,
Constant Field Valuespublic static final java.lang.String JMQQueueBrowserMaxMessagesPerRetrieve
imqQueueBrowserMaxMessagesPerRetrieve
,
Constant Field Valuespublic static final java.lang.String imqLoadMaxToServerSession
When set to true
, Sun MQ will load as many messages
as are available, upto the limit of the maxMessages
parameter used when creating the ConnectionConsumer, using the
createConnectionConsumer()
API, into a
ServerSession's JMS Session for processing.
When set to false
, Sun MQ will only load a single message
into a ServerSession's JMS Session for processing.
The default value of this property is true
javax.jms.ConnectionConsumer
,
QueueConnection.createConnectionConsumer(Queue, messageSelector, ServerSessionPool, maxMessages)
,
TopicConnection.createConnectionConsumer(Topic, messageSelector, ServerSessionPool, maxMessages)
,
TopicConnection.createDurableConnectionConsumer(Topic, subscriptionName, messageSelector, ServerSessionPool, maxMessages)
,
Constant Field Valuespublic static final java.lang.String JMQLoadMaxToServerSession
imqLoadMaxToServerSession
,
Constant Field Valuespublic static final java.lang.String imqOverrideJMSDeliveryMode
JMSDeliveryMode
which can be set using the JMS APIs.
When this property is set to true
Sun MQ will set the Message Header
JMSDeliveryMode
to the value of the property
imqJMSDeliveryMode
for all messages produced by
the Connection created using this Administered Object.
If imqJMSDeliveryMode
has an invalid value, then the default value of the JMS Message
Header JMSDeliveryMode
will be used instead.
value.
The default value of this property is false
imqJMSDeliveryMode
,
MessageProducer.setDeliveryMode(deliveryMode)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
Constant Field Valuespublic static final java.lang.String JMQOverrideJMSDeliveryMode
imqOverrideJMSDeliveryMode
,
Constant Field Valuespublic static final java.lang.String imqJMSDeliveryMode
JMSDeliveryMode
.
When imqOverrideJMSDeliveryMode
is set to true
,
all messages produced to non-Temporary Destinations
by the Connection created using this Administered
Object will have their JMS Message Header JMSDeliveryMode
set to the value of this property.
In addition, when imqOverrideJMSHeadersToTemporaryDestinations
is set
to true
, all messages produced to Temporary Destinations
will also contain the overridenvalue of this JMS Message Header.
Setting an invalid value on this property
will result in the Message Header being set to the default value of
JMSDeliveryMode
as defined by the JMS Specification.
The default value of this property is null
imqOverrideJMSDeliveryMode
,
JMSDeliveryMode_PERSISTENT
,
JMSDeliveryMode_NON_PERSISTENT
,
Message.DEFAULT_DELIVERY_MODE
,
DeliveryMode.PERSISTENT
,
DeliveryMode.NON_PERSISTENT
,
MessageProducer.setDeliveryMode(deliveryMode)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
Constant Field Valuespublic static final java.lang.String JMSDeliveryMode_PERSISTENT
imqJMSDeliveryMode
to PERSISTENT when the JMSDeliveryMode JMS Message Header
is administratively configured.
imqOverrideJMSDeliveryMode
,
imqJMSDeliveryMode
,
Constant Field Valuespublic static final java.lang.String JMSDeliveryMode_NON_PERSISTENT
imqJMSDeliveryMode
to NON_PERSISTENT when the JMSDeliveryMode JMS Message Header
is administratively configured.
imqOverrideJMSDeliveryMode
,
imqJMSDeliveryMode
,
Constant Field Valuespublic static final java.lang.String JMQJMSDeliveryMode
imqJMSDeliveryMode
,
Constant Field Valuespublic static final java.lang.String imqOverrideJMSExpiration
JMSExpiration
which can be set using the JMS APIs.
When this property is set to true
Sun MQ will set the Message Header
JMSExpiration
to the value of the property
imqJMSExpiration
for all messages produced by
the Connection created using this Administered Object.
If imqJMSExpiration
has an invalid value, then the default value of the JMS Message
Header JMSExpiration
will be used instead.
value.
The default value of this property is false
imqJMSExpiration
,
MessageProducer.setTimeToLive(timeToLive)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
Constant Field Valuespublic static final java.lang.String JMQOverrideJMSExpiration
imqOverrideJMSExpiration
,
Constant Field Valuespublic static final java.lang.String imqJMSExpiration
JMSExpiration
.
When imqOverrideJMSExpiration
is set to true
,
all messages produced to non-Temporary Destinations
by the Connection created using this Administered
Object will have their JMS Message Header JMSExpiration
set to the value of this property.
In addition, when imqOverrideJMSHeadersToTemporaryDestinations
is set
to true
, all messages produced to Temporary Destinations
will also contain the overridenvalue of this JMS Message Header.
Setting an invalid value on this property
will result in the Message Header being set to the default value of
JMSExpiration
as defined by the JMS Specification.
The JMS Specification defines JMSExpiration
as the time in
milliseconds from its dispatch time that a produced message should be
retained by the message service. An value of 0
indicates
that the message is retained indefinitely.
The default value of JMSExpiration
is 0
.
The default value of this property is null
imqOverrideJMSExpiration
,
Message.DEFAULT_TIME_TO_LIVE
,
MessageProducer.setTimeToLive(timeToLive)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
Constant Field Valuespublic static final java.lang.String JMQJMSExpiration
imqJMSExpiration
,
Constant Field Valuespublic static final java.lang.String imqOverrideJMSPriority
JMSPriority
which can be set using the JMS APIs.
When this property is set to true
Sun MQ will set the Message Header
JMSPriority
to the value of the property
imqJMSPriority
for all messages produced by
all messages produced to non-Temporary Destinations
by the Connection created using this Administered Object.
If imqJMSPriority
has an invalid value, then the default value of the JMS Message
Header JMSPriority
will be used instead.
value.
The default value of this property is false
imqJMSPriority
,
MessageProducer.setPriority(priority)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
DeliveryMode.PERSISTENT
,
DeliveryMode.NON_PERSISTENT
,
Constant Field Valuespublic static final java.lang.String JMQOverrideJMSPriority
imqOverrideJMSPriority
,
Constant Field Valuespublic static final java.lang.String imqJMSPriority
JMSPriority
.
When imqOverrideJMSPriority
is set to true
,
all messages produced to non-Temporary Destinations
by the Connection created using this Administered
Object will have their JMS Message Header JMSPriority
set to the value of this property.
In addition, when imqOverrideJMSHeadersToTemporaryDestinations
is set
to true
, all messages produced to Temporary Destinations
will also contain the overridenvalue of this JMS Message Header.
Setting an invalid value on this property
will result in the Message Header being set to the default value of
JMSPriority
as defined by the JMS Specification.
The JMS Specification defines a 10 level value for JMSPriority
,
the priority with which produced messages are delivered by the message service, with 0 as the lowest
and 9 as the highest. Clients should consider 0-4 as gradients of normal priority
and 5-9 as gradients of expedited priority. JMSPriority
is set to 4, by default.
The default value of this property is null
imqOverrideJMSPriority
,
Message.DEFAULT_PRIORITY
,
MessageProducer.setPriority(priority)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
Constant Field Valuespublic static final java.lang.String JMQJMSPriority
imqJMSPriority
,
Constant Field Valuespublic static final java.lang.String imqOverrideJMSHeadersToTemporaryDestinations
When imqOverrideJMSHeadersToTemporaryDestinations
is set to
true
, imq will override the JMS Message Headers listed below
on Messages sent to Temporary Destinations providing the corresponding
property enabling the JMS Message Header override on Messages sent to
non-temporary Destinations is also set to true
.
JMSPriority
JMSExpiration
JMSDeliveryMode
The default value of this property is false
imqOverrideJMSDeliveryMode
,
imqJMSDeliveryMode
,
imqOverrideJMSExpiration
,
imqJMSExpiration
,
imqOverrideJMSPriority
,
imqJMSPriority
,
MessageProducer.setDeliveryMode(deliveryMode)
,
MessageProducer.setTimeToLive(timeToLive)
,
MessageProducer.setPriority(priority)
,
QueueSender.send(Message, deliveryMode, priority, timeToLive)
,
QueueSender.send(Queue, Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Message, deliveryMode, priority, timeToLive)
,
QueueSender.publish(Topic, Message, deliveryMode, priority, timeToLive)
,
DeliveryMode.PERSISTENT
,
DeliveryMode.NON_PERSISTENT
,
Constant Field Valuespublic static final java.lang.String JMQOverrideJMSHeadersToTemporaryDestinations
imqOverrideJMSHeadersToTemporaryDestinations
,
Constant Field Values
|
Message Queue, v4.4 API Specification | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |