ConnectionFactory (SonicMQ API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

SonicMQ API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

progress.message.jclient
Class ConnectionFactory

java.lang.Object
  progress.message.jclient.ConnectionFactory

All Implemented Interfaces:: java.io.Serializable, ConnectionFactory, javax.naming.Referenceable

Direct Known Subclasses:: QueueConnectionFactory, TopicConnectionFactory, XAConnectionFactory

public class ConnectionFactory
extends java.lang.Object
implements ConnectionFactory, javax.naming.Referenceable, java.io.Serializable
extends java.lang.Object
implements ConnectionFactory, javax.naming.Referenceable, java.io.Serializable

An implementation of a JMS ConnectionFactory. A client uses a ConnectionFactory to create Connections with a JMS Pub/Sub provider. This class provides all common methods for the subclasses, QueueConnectionFactory, TopicConnectionFactory, XAQueueConnectionFactory, and XATopicConnectionFactory.

Version:: 2.0 - 12 Feb 2003
Author:: Tim Bemis
See Also:: QueueConnectionFactory, TopicConnectionFactory, XAQueueConnectionFactory, XATopicConnectionFactory, Serialized Form

Field Summary
`static java.lang.Integer`	`ASYNCHRONOUS_DELIVERY_MODE_DEFAULT` The default value for setAsynchronousDeliveryMode(Integer): specifies that the SonicMQ client runtime should make the decision whether or not to send messages asynchronously.
`static java.lang.String`	`CLIENT_TRANSACTION_BUFFER_SIZE`
`static java.lang.String`	`COMPRESSION_FACTORY`
`static java.lang.String`	`COMPRESSION_METRICS_LISTENER`
`static java.lang.Long`	`DELIVERY_CLOSE_TIMEOUT_DEFAULT` Default value for setDeliveryCloseTimeout(Long): do not wait for messages to be delivered on close.
`static java.lang.Integer`	`DELIVERY_DOUBT_WINDOW_DEFAULT` Default value for setDeliveryDoubtWindow(Integer): no limit on the number of in doubt messages.
`static java.lang.String`	`ENABLE_COMPRESSION`
`static java.lang.String`	`ENABLE_LOCAL_STORE`
`static java.lang.String`	`FAULT_TOLERANT`
`static java.lang.String`	`FAULT_TOLERANT_RECONNECT_TIMEOUT`
`static java.lang.String`	`FLOW_TO_DISK`
`static java.lang.String`	`HTTP`
`static java.lang.String`	`INITIAL_CONNECT_TIMEOUT`
`static java.lang.String`	`LG_DOWN_STREAM_NODE_TYPE`
`static java.lang.String`	`LG_ENABLED`
`static java.lang.String`	`LOCAL_STORE_DIRECTORY`
`static java.lang.String`	`LOCAL_STORE_LISTENER_FACTORY_CLASS`
`static java.lang.String`	`LOCAL_STORE_SIZE`
`static java.lang.String`	`LOCAL_STORE_WAIT_TIME`
`static java.lang.String`	`LOGIN_SPI_OBJECT` This variable stores the Login SPI implementaion object into the env.
`static java.lang.String`	`MINIMIZE_SUBSCRIBER_TRAFFIC`
`static java.lang.String`	`PING_INTERVAL`
`static java.lang.String`	`RECONNECT_INTERVAL`
`static java.lang.String`	`RECONNECT_TIMEOUT`
`static java.lang.String`	`SOCKET_CONNECT_TIMEOUT`
`static java.lang.String`	`SSL`
`static java.lang.String`	`TCP`

Constructor Summary
`ConnectionFactory()` Construct a ConnectionFactory with the default URL
`ConnectionFactory(java.lang.String brokerURL)` Construct a ConnectionFactory (with a default connectID, user and password of "").
`ConnectionFactory(java.lang.String brokerHostName, int brokerPort, java.lang.String brokerProtocol, java.lang.String defaultUserName, java.lang.String defaultPassword)` Construct a ConnectionFactory (with a default connectID of null).
`ConnectionFactory(java.lang.String brokerHostName, int brokerPort, java.lang.String brokerProtocol, java.lang.String connectID, java.lang.String defaultUserName, java.lang.String defaultPassword)` Construct a ConnectionFactory.
`ConnectionFactory(java.lang.String brokerURL, java.lang.String connectID)` Construct a ConnectionFactory (with a default user and password of "").
`ConnectionFactory(java.lang.String brokerURL, java.lang.String defaultUserName, java.lang.String defaultPassword)` Construct a ConnectionFactory (with a default connectID of null).
`ConnectionFactory(java.lang.String brokerURL, java.lang.String connectID, java.lang.String defaultUserName, java.lang.String defaultPassword)` Construct a ConnectionFactory.

Method Summary
`Connection`	`createConnection()` Creates a connection with the default user identity.
`Connection`	`createConnection(java.lang.String userName, java.lang.String password)` Creates a connection with the specified user identity.
`java.applet.Applet`	`getApplet()`
`java.lang.Integer`	`getAsynchronousDeliveryMode()` Gets whether or not messages sent by MessageProducers on a Connection's producers should be sent to the broker synchronously or asynchronously.
`java.lang.String`	`getBrokerHostName()`
`int`	`getBrokerPort()`
`java.lang.String`	`getBrokerProtocol()`
`java.lang.String`	`getBrokerURL()`
`java.lang.String`	`getClientID()`
`java.lang.Long`	`getClientTransactionBufferSize()` Get client transaction buffer size.
`java.lang.String`	`getCompressionFactory()` Queries the ConnectionFactory of the class name of the compression factory.
`java.lang.String`	`getConnectID()`
`java.lang.String`	`getConnectionURLs()` Return list of brokers to try to connect to.
`java.lang.String`	`getDefaultPassword()`
`int`	`getDefaultTxnBatchSize()` Gets the default batch size
`java.lang.Integer`	`getDefaultTxnBatchSizeInteger()` Gets the default batch size
`java.lang.String`	`getDefaultUser()`
`java.lang.Long`	`getDeliveryCloseTimeout()` The amount of time in milliseconds to wait on a per Session basis for unsent messages to be sent to the broker when a Session is closed.
`java.lang.Integer`	`getDeliveryDoubtWindow()` Gets the limit on the number of unacknowledged messages per Session when asynchronous message delivery is enabled.
`java.lang.Boolean`	`getDurableMessageOrder()` Determines whether the option to preserve message order when reconnecting a durable subscriber has been selected.
`boolean`	`getEnableActionalInstrumentation()` Queries the ConnectionFactory to see if the LG instrumentation is currently enabled.
`java.lang.Boolean`	`getEnableActionalInstrumentationBoolean()` Queries the ConnectionFactory to see if the LG instrumentation is currently enabled.
`boolean`	`getEnableCompression()` Queries the ConnectionFactory to see if compression is enabled.
`java.lang.Boolean`	`getEnableCompressionBoolean()` Queries the ConnectionFactory to see if compression is enabled.
`java.lang.Boolean`	`getFaultTolerant()` Determines whether fault tolerant connection creation is enabled.
`java.lang.Integer`	`getFaultTolerantReconnectTimeout()` Get fault tolerance reconnect timeout.
`java.lang.Integer`	`getFlowToDisk()` Determines the setting of Flow-To-Disk Publishing property.
`java.lang.Integer`	`getInitialConnectTimeout()` Get initial connect timeout for a fault-tolerant connection.
`java.lang.Integer`	`getInitialRcvBufferSize()` Gets the initial size of the buffer (in bytes) used when reading message traffic from the network transport.
`java.lang.Integer`	`getInitialSendBufferSize()` Gets the initial size of the buffer (in bytes) used to buffer message traffic prior to writing to the network transport.
`int`	`getLGDownStreamNodeType()`
`boolean`	`getLoadBalancing()` Determines whether client-side load balancing is enabled.
`java.lang.Boolean`	`getLoadBalancingBoolean()` Determines whether client-side load balancing is enabled.
`java.lang.String`	`getLoadBalancingClientData()` Gets the additional information to be provided to the broker side load balancer to assist in making load balancing decisions.
`java.lang.String`	`getLocalStoreDirectory()` Gets the name of the directory where the local storage for the persistent client connection is located.
`long`	`getLocalStoreSize()` Get limit on how many messages can be stored locally on the persistent client while operating disconnected(offline).
`java.lang.Long`	`getLocalStoreSizeLong()` Get limit on how many messages can be stored locally on the persistent client while operating disconnected(offline).
`java.lang.Integer`	`getLocalStoreWaitTime()` Gets the limit (in seconds) on how long a sender send call waits before the message is written to the local store.
`java.lang.String`	`getLoginSPI()` Used to set the class name that implements ILogin interface.
`java.lang.Integer`	`getMaxDeliveryCount()` Gets the maximum number of times delivery of a message to a consumer should be attempted.
`java.lang.Integer`	`getMaxRcvBufferSize()` Gets the maximum size of the buffer (in bytes) used when reading message traffic from the network transport.
`java.lang.Integer`	`getMaxSendBufferSize()` Gets the maximum size of the buffer (in bytes) used to buffer message traffic prior to writing to the network transport.
`boolean`	`getMinimizeSubscriberTraffic()` Queries the ConnectionFactory to see if subscriber traffic is to be minimized.
`java.lang.Boolean`	`getMinimizeSubscriberTrafficBoolean()` Queries the ConnectionFactory to see if subscriber traffic is to be minimized.
`java.lang.Integer`	`getMinRcvBufferSize()` Gets the minimum size of the buffer (in bytes) used when reading message traffic from the network transport.
`java.lang.Integer`	`getMinSendBufferSize()` Gets the minimum size of the buffer (in bytes) used to buffer message traffic prior to writing to the network transport.
`java.lang.Integer`	`getMonitorInterval()` Gets the administrative flow control monitoring interval.
`boolean`	`getPersistentDelivery()` Determines whether the default of PERSISTENT delivery should be applied to publishers.
`java.lang.Boolean`	`getPersistentDeliveryBoolean()` Determines whether the default of PERSISTENT delivery should be applied to publishers.
`long`	`getPingInterval()` Get the connection ping interval.
`java.lang.Long`	`getPingIntervalLong()` Get the connection ping interval.
`int`	`getPrefetchCount()` Get the prefetch count for the QueueReceiver.
`java.lang.Integer`	`getPrefetchCountInteger()` Get the prefetch count for the QueueReceiver.
`int`	`getPrefetchThreshold()` Get the default prefetch threshold for the QueueReceiver.
`java.lang.Integer`	`getPrefetchThresholdInteger()` Get the prefetch threshold for the QueueReceiver.
`java.lang.Integer`	`getQopCacheSize()` Gets the number of destination<->QOP entries that are retained for Sessions that are derived from this factory.
`int`	`getReconnectInterval()` Applicable to persistent client connections only.
`java.lang.Integer`	`getReconnectIntervalInteger()` Applicable to persistent client connections only.
`int`	`getReconnectTimeout()` Applicable to persistent client connections only.
`java.lang.Integer`	`getReconnectTimeoutInteger()` Applicable to persistent client connections only.
`javax.naming.Reference`	`getReference()` Return a javax.naming.Reference object which contains the reference information necessary to create an object of the proper type.
`boolean`	`getRequireActionalJMSNode()` Queries if the JMS node should be reported by the LG upstream node, i.e., the broker.
`java.lang.Boolean`	`getRequireActionalJMSNodeBoolean()` Queries if the JMS node should be reported by the LG upstream node, i.e., the broker.
`java.lang.Boolean`	`getRethrowCCRuntimeExceptions()` Gets the value for determining whether to rethrow RuntimeExceptions encountered by a ConnectionConsumer's onMesssage().
`java.lang.Boolean`	`getSelectorAtBroker()`
`boolean`	`getSequential()` Determines whether the option to start with the first or a random element of the broker list has been selected.
`java.lang.Boolean`	`getSequentialBoolean()` Determines whether the option to start with the first or a random element of the broker list has been selected.
`java.lang.Integer`	`getSocketConnectTimeout()` Gets the setting of the socket connect timeout property.
`java.lang.Boolean`	`getSplitMultiTopicDelivery()` Gets the default value for splitting MultiTopic message delivery.
`java.lang.String`	`getUrlsOrUrl()` Return list of brokers to try to connect to.
`boolean`	`isEnableLocalStore()` Queries the ConnectionFactory to see if the LocalStore feature(persistent client feature) is currently enabled.
`java.lang.Boolean`	`isEnableLocalStoreBoolean()` Queries the ConnectionFactory to see if the LocalStore feature(persistent client feature) is currently enabled.
`void`	`setApplet(java.applet.Applet applet)`
`void`	`setAsynchronousDeliveryMode(java.lang.Integer mode)` Sets whether or not messages sent by MessageProducers on a connection's producers should be sent to the broker synchronously or asynchronously.
`void`	`setBrokerHostName(java.lang.String brokerHostName)`
`void`	`setBrokerPort(int brokerPort)`
`void`	`setBrokerProtocol(java.lang.String brokerProtocol)`
`void`	`setBrokerURL(java.lang.String brokerURL)`
`void`	`setClientID(java.lang.String clientID)`
`void`	`setClientTransactionBufferSize(java.lang.Long size)` Set client transaction buffer size.
`void`	`setCompressionFactory(java.lang.String factory)` Set the class name of the compression factory.
`void`	`setConnectID(java.lang.String connectID)`
`void`	`setConnectionURLs(java.lang.String brokerList)` Configures a list of brokers to try when creating a connection.
`void`	`setDefaultPassword(java.lang.String password)`
`void`	`setDefaultTxnBatchSize(int size)` Sets the default batch size of all sessions, created via connections created from this ConnectionFactory.
`void`	`setDefaultTxnBatchSizeInteger(java.lang.Integer size)` Sets the default batch size of all sessions, created via connections created from this ConnectionFactory.
`void`	`setDefaultUser(java.lang.String username)`
`void`	`setDeliveryCloseTimeout(java.lang.Long timeout)` The amount of time in milliseconds to wait on a per Session basis for unsent messages to be sent to the broker when a Session is closed.
`void`	`setDeliveryDoubtWindow(java.lang.Integer numMessages)` Sets the limit on the number of unacknowledged messages per Session when asynchronous message delivery is enabled.
`void`	`setDurableMessageOrder(java.lang.Boolean durableSubscriberMessageOrder)` Enable or disable preservation of message order for reconnecting durable subscribers.
`void`	`setEnableActionalInstrumentation(boolean enabled)` Set to indicate if the LG instrumentation is enabled locally.
`void`	`setEnableActionalInstrumentationBoolean(java.lang.Boolean enabled)` Set to indicate if the LG instrumentation is enabled locally.
`void`	`setEnableCompression(boolean enabled)` Set to indicate if compression should be enabled for the connections.
`void`	`setEnableCompressionBoolean(java.lang.Boolean enabled)` Set to indicate if compression should be enabled for the connections.
`void`	`setEnableLocalStore(boolean value)` Enable the LocalStore feature(persistent client feature).Enabling the persistent client provides a way for a client application to continue sending messages despite losing connection with the broker.
`void`	`setEnableLocalStoreBoolean(java.lang.Boolean value)` Enable the LocalStore feature(persistent client feature).Enabling the persistent client provides a way for a client application to continue sending messages despite losing connection with the broker.
`void`	`setFaultTolerant(java.lang.Boolean faultTolerant)` Enable or disable fault tolerant connection creation.
`void`	`setFaultTolerantReconnectTimeout(java.lang.Integer seconds)` Set fault tolerance reconnect timeout.
`void`	`setFlowToDisk(java.lang.Integer flag)` Enable or disable Flow-To-Disk Publishing.
`void`	`setInitialConnectTimeout(java.lang.Integer seconds)` Set initial connect timeout for a fault-tolerant connection.
`void`	`setInitialRcvBufferSize(java.lang.Integer value)` Sets the initial size of the buffer (in bytes) used when reading message traffic from the network transport.
`void`	`setInitialSendBufferSize(java.lang.Integer value)` Sets the initial size of the buffer (in bytes) used to buffer message traffic prior to writing to the network transport.
`void`	`setLGDownStreamNodeType(int peerType)`
`void`	`setLoadBalancing(boolean loadBalancing)` Enable or disable client-side load balancing.
`void`	`setLoadBalancingBoolean(java.lang.Boolean loadBalancing)` Enable or disable client-side load balancing.
`void`	`setLoadBalancingClientData(java.lang.String clientData)` This can be set to provide additional information to assist the broker side load balancer when making load balancing decisions.
`void`	`setLocalStoreDirectory(java.lang.String name)` Sets the name of the directory where the local storage for the persistent client connection will be located.
`void`	`setLocalStoreSize(long size)` Sets limit on how many messages can be stored locally on the persistent client while operating disconnected(offline).
`void`	`setLocalStoreSizeLong(java.lang.Long size)` Sets limit on how many messages can be stored locally on the persistent client while operating disconnected(offline).
`void`	`setLocalStoreWaitTime(java.lang.Integer secs)` Sets the limit (in seconds) on how long a sender send call waits before the message is written to the local store.
`void`	`setLoginSPI(java.lang.String className)` Used to set the class name that implements ILogin interface.
`void`	`setMaxDeliveryCount(java.lang.Integer value)` Sets the maximum number of times delivery of a message to a consumer should be attempted.
`void`	`setMaxRcvBufferSize(java.lang.Integer value)` Sets the maximum size of the buffer (in bytes) used when reading message traffic from the network transport.
`void`	`setMaxSendBufferSize(java.lang.Integer value)` Sets the maximum size of the buffer (in bytes) used to buffer message traffic prior to writing to the network transport.
`void`	`setMinimizeSubscriberTraffic(boolean minimizeTraffic)` Set to minimizethe traffic for TopicSubscriber and DurableSubscriber.
`void`	`setMinimizeSubscriberTrafficBoolean(java.lang.Boolean minimizeTraffic)` Set to minimizethe traffic for TopicSubscriber and DurableSubscriber.
`void`	`setMinRcvBufferSize(java.lang.Integer value)` Sets the minimum size of the buffer (in bytes) used when reading message traffic from the network transport.
`void`	`setMinSendBufferSize(java.lang.Integer value)` Sets the minimum size of the buffer (in bytes) used to buffer message traffic prior to writing to the network transport.
`void`	`setMonitorInterval(java.lang.Integer interval)` Set the administrative flow control monitoring interval.
`void`	`setPersistentDelivery(boolean persistentDelivery)` Enable or disable persistent delivery.
`void`	`setPersistentDeliveryBoolean(java.lang.Boolean persistentDelivery)` Enable or disable persistent delivery.
`void`	`setPingInterval(long interval)` Enable/disable sending active pings on a connection.
`void`	`setPingIntervalLong(java.lang.Long interval)` Enable/disable sending active pings on a connection.
`void`	`setPrefetchCount(int count)` Set the prefetch count for the QueueReceiver.
`void`	`setPrefetchCountInteger(java.lang.Integer count)` Set the prefetch count for the QueueReceiver.
`void`	`setPrefetchThreshold(int val)` Set the default prefetch threshold for the QueueReceivers.
`void`	`setPrefetchThresholdInteger(java.lang.Integer val)` Set the default prefetch threshold for the QueueReceiver.
`void`	`setQopCacheSize(java.lang.Integer value)` Sets the number of destination<->QOP entries that are retained for Sessions that are derived from this factory.
`void`	`setReconnectInterval(int secs)` Applicable to persistent client connections only.
`void`	`setReconnectIntervalInteger(java.lang.Integer secs)` Applicable to persistent client connections only.
`void`	`setReconnectTimeout(int minutes)` Applicable to persistent client connections only.
`void`	`setReconnectTimeoutInteger(java.lang.Integer minutes)` Applicable to persistent client connections only.
`void`	`setRequireActionalJMSNode(boolean required)` Set to indicate if the JMS node should be reported by the LG upstream node, i.e., the broker.
`void`	`setRequireActionalJMSNodeBoolean(java.lang.Boolean required)` Set to indicate if the JMS node should be reported by the LG upstream node, i.e., the broker.
`void`	`setRethrowCCRuntimeExceptions(java.lang.Boolean value)` Sets the value for determining whether to rethrow RuntimeExceptions encountered by a ConnectionConsumer's onMesssage().
`void`	`setSelectorAtBroker(java.lang.Boolean flag)` If set to true, the message selector logic is performed at the JMS server (broker).
`void`	`setSequential(boolean sequential)` Specifies whether to start with the first broker in the list or a random element.
`void`	`setSequentialBoolean(java.lang.Boolean sequential)` Specifies whether to start with the first broker in the list or a random element.
`void`	`setSocketConnectTimeout(java.lang.Integer value)` Sets a timeout to be used when establishing a socket connection to the broker.
`void`	`setSplitMultiTopicDelivery(java.lang.Boolean value)` Sets the default value for splitting MultiTopic message delivery.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

ENABLE_LOCAL_STORE

public static final java.lang.String ENABLE_LOCAL_STORE

See Also:: Constant Field Values

LOCAL_STORE_DIRECTORY

public static final java.lang.String LOCAL_STORE_DIRECTORY

See Also:: Constant Field Values

LOCAL_STORE_SIZE

public static final java.lang.String LOCAL_STORE_SIZE

See Also:: Constant Field Values

LOCAL_STORE_WAIT_TIME

public static final java.lang.String LOCAL_STORE_WAIT_TIME

See Also:: Constant Field Values

RECONNECT_TIMEOUT

public static final java.lang.String RECONNECT_TIMEOUT

See Also:: Constant Field Values

RECONNECT_INTERVAL

public static final java.lang.String RECONNECT_INTERVAL

See Also:: Constant Field Values

LOCAL_STORE_LISTENER_FACTORY_CLASS

public static final java.lang.String LOCAL_STORE_LISTENER_FACTORY_CLASS

See Also:: Constant Field Values

PING_INTERVAL

public static final java.lang.String PING_INTERVAL

See Also:: Constant Field Values

FAULT_TOLERANT

public static final java.lang.String FAULT_TOLERANT

See Also:: Constant Field Values

FAULT_TOLERANT_RECONNECT_TIMEOUT

public static final java.lang.String FAULT_TOLERANT_RECONNECT_TIMEOUT

See Also:: Constant Field Values

INITIAL_CONNECT_TIMEOUT

public static final java.lang.String INITIAL_CONNECT_TIMEOUT

See Also:: Constant Field Values

CLIENT_TRANSACTION_BUFFER_SIZE

public static final java.lang.String CLIENT_TRANSACTION_BUFFER_SIZE

See Also:: Constant Field Values

FLOW_TO_DISK

public static final java.lang.String FLOW_TO_DISK

See Also:: Constant Field Values

SOCKET_CONNECT_TIMEOUT

public static final java.lang.String SOCKET_CONNECT_TIMEOUT

See Also:: Constant Field Values

LG_ENABLED

public static final java.lang.String LG_ENABLED

See Also:: Constant Field Values

LG_DOWN_STREAM_NODE_TYPE

public static final java.lang.String LG_DOWN_STREAM_NODE_TYPE

See Also:: Constant Field Values

ENABLE_COMPRESSION

public static final java.lang.String ENABLE_COMPRESSION

See Also:: Constant Field Values

COMPRESSION_FACTORY

public static final java.lang.String COMPRESSION_FACTORY

See Also:: Constant Field Values

COMPRESSION_METRICS_LISTENER

public static final java.lang.String COMPRESSION_METRICS_LISTENER

See Also:: Constant Field Values

MINIMIZE_SUBSCRIBER_TRAFFIC

public static final java.lang.String MINIMIZE_SUBSCRIBER_TRAFFIC

See Also:: Constant Field Values

TCP

public static final java.lang.String TCP

See Also:: Constant Field Values

HTTP

public static final java.lang.String HTTP

See Also:: Constant Field Values

SSL

public static final java.lang.String SSL

See Also:: Constant Field Values

LOGIN_SPI_OBJECT

public static final java.lang.String LOGIN_SPI_OBJECT

This variable stores the Login SPI implementaion object into the env.

See Also:: Constant Field Values

DELIVERY_CLOSE_TIMEOUT_DEFAULT

public static final java.lang.Long DELIVERY_CLOSE_TIMEOUT_DEFAULT

Default value for setDeliveryCloseTimeout(Long): do not wait for messages to be delivered on close.

DELIVERY_DOUBT_WINDOW_DEFAULT

public static final java.lang.Integer DELIVERY_DOUBT_WINDOW_DEFAULT

Default value for setDeliveryDoubtWindow(Integer): no limit on the number of in doubt messages.

ASYNCHRONOUS_DELIVERY_MODE_DEFAULT

public static final java.lang.Integer ASYNCHRONOUS_DELIVERY_MODE_DEFAULT

The default value for setAsynchronousDeliveryMode(Integer): specifies that the SonicMQ client runtime should make the decision whether or not to send messages asynchronously.

Constructor Detail

ConnectionFactory

public ConnectionFactory()
                  throws JMSException

Construct a ConnectionFactory with the default URL

Throws:: JMSException

ConnectionFactory

public ConnectionFactory(java.lang.String brokerURL)
                  throws JMSException

Construct a ConnectionFactory (with a default connectID, user and password of "").

Parameters:: brokerURL - the URL (in the form [protocol://]hostname[:port]) of the message broker to which connection are made.
Throws:: JMSException - if a connection factory can not be created.

ConnectionFactory

public ConnectionFactory(java.lang.String brokerURL,
                         java.lang.String connectID)
                  throws JMSException

Construct a ConnectionFactory (with a default user and password of "").

Parameters:: brokerURL - the URL (in the form [protocol://]hostname[:port]) of the message broker to which connection are made.; connectID - the id string used to identify connection. May be null.
Throws:: JMSException - if a connection factory can not be created.

ConnectionFactory

public ConnectionFactory(java.lang.String brokerURL,
                         java.lang.String defaultUserName,
                         java.lang.String defaultPassword)
                  throws JMSException

Construct a ConnectionFactory (with a default connectID of null).

Parameters:: brokerURL - the URL (in the form [protocol://]hostname[:port]) of the message broker to which connection are made.; defaultUserName - the default user name; defaultPassword - the default password
Throws:: JMSException - if a connection factory can not be created.

ConnectionFactory

public ConnectionFactory(java.lang.String brokerURL,
                         java.lang.String connectID,
                         java.lang.String defaultUserName,
                         java.lang.String defaultPassword)
                  throws JMSException

Construct a ConnectionFactory.

Parameters:: brokerURL - the URL (in the form [protocol://]hostname[:port]) of the message broker to which connection are made.; connectID - the id string used to identify connection. This may be null.; defaultUserName - the default user name; defaultPassword - the default password
Throws:: JMSException - if a connection factory can not be created.

ConnectionFactory

public ConnectionFactory(java.lang.String brokerHostName,
                         int brokerPort,
                         java.lang.String brokerProtocol,
                         java.lang.String defaultUserName,
                         java.lang.String defaultPassword)
                  throws JMSException

Construct a ConnectionFactory (with a default connectID of null).

Parameters:: brokerHostName - the broker host name,; brokerPort - the broker port number; brokerProtocol - the broker protocol, can be null or ""; defaultUserName - the default user name; defaultPassword - the default password
Throws:: JMSException - if a connection factory can not be created.

ConnectionFactory

public ConnectionFactory(java.lang.String brokerHostName,
                         int brokerPort,
                         java.lang.String brokerProtocol,
                         java.lang.String connectID,
                         java.lang.String defaultUserName,
                         java.lang.String defaultPassword)
                  throws JMSException

Construct a ConnectionFactory.

Parameters:: brokerHostName - the broker host name,; brokerPort - the broker port number; brokerProtocol - the broker protocol, can be null or ""; connectID - the id string used to identify connection. This may be null.; defaultUserName - the default user name; defaultPassword - the default password
Throws:: JMSException - if a connection factory can not be created.

Method Detail

setEnableLocalStore

public void setEnableLocalStore(boolean value)

Enable the LocalStore feature(persistent client feature).Enabling the persistent client provides a way for a client application to continue sending messages despite losing connection with the broker. Messages sent by the client are saved in a persistent store on the client system until connection is established at which time the accrued messages are sent.

Parameters:: value - the boolean value to enable/disable the feature
See Also:: isEnableLocalStore(), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSize(long), getLocalStoreSize(), setReconnectTimeout(int), getReconnectTimeout(), setReconnectInterval(int), getReconnectInterval(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

setEnableLocalStoreBoolean

public void setEnableLocalStoreBoolean(java.lang.Boolean value)

Parameters:: value - the Boolean value to enable/disable the feature
See Also:: isEnableLocalStoreBoolean(), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSizeLong(Long), getLocalStoreSizeLong(), setReconnectTimeoutInteger(Integer), getReconnectTimeoutInteger(), setReconnectIntervalInteger(Integer), getReconnectIntervalInteger(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

isEnableLocalStore

public boolean isEnableLocalStore()

Queries the ConnectionFactory to see if the LocalStore feature(persistent client feature) is currently enabled.

Returns:: boolean value of true if the feature is enabled.
See Also:: setEnableLocalStore(boolean), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSize(long), getLocalStoreSize(), setReconnectTimeout(int), getReconnectTimeout(), setReconnectInterval(int), getReconnectInterval(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

isEnableLocalStoreBoolean

public java.lang.Boolean isEnableLocalStoreBoolean()

Queries the ConnectionFactory to see if the LocalStore feature(persistent client feature) is currently enabled.

Returns:: Boolean value of true if the feature is enabled.
See Also:: setEnableLocalStoreBoolean(Boolean), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSizeLong(Long), getLocalStoreSizeLong(), setReconnectTimeoutInteger(Integer), getReconnectTimeoutInteger(), setReconnectIntervalInteger(Integer), getReconnectIntervalInteger(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

setLocalStoreDirectory

public void setLocalStoreDirectory(java.lang.String name)

Sets the name of the directory where the local storage for the persistent client connection will be located. When you have multiple connections, use different directories to avoid unpredictable behaviors.

Parameters:: name - String value containing the name of the directory to use (default is the current working directory)
See Also:: setEnableLocalStore(boolean), isEnableLocalStore(), getLocalStoreDirectory(), setLocalStoreSize(long), getLocalStoreSize(), setReconnectTimeout(int), getReconnectTimeout(), setReconnectInterval(int), getReconnectInterval(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

getLocalStoreDirectory

public java.lang.String getLocalStoreDirectory()

Gets the name of the directory where the local storage for the persistent client connection is located.

Returns:: client local storage location.
See Also:: setEnableLocalStore(boolean), isEnableLocalStore(), setLocalStoreDirectory(String), setLocalStoreSize(long), getLocalStoreSize(), setReconnectTimeout(int), getReconnectTimeout(), setReconnectInterval(int), getReconnectInterval(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

setLocalStoreSize

public void setLocalStoreSize(long size)

Sets limit on how many messages can be stored locally on the persistent client while operating disconnected(offline). The default value is 10000 (10MB).

Parameters:: size - maximum size of the local store (in Kilobytes).
See Also:: setEnableLocalStore(boolean), isEnableLocalStore(), setLocalStoreDirectory(String), getLocalStoreDirectory(), getLocalStoreSize(), setReconnectTimeout(int), getReconnectTimeout(), setReconnectInterval(int), getReconnectInterval(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

setLocalStoreSizeLong

public void setLocalStoreSizeLong(java.lang.Long size)

Sets limit on how many messages can be stored locally on the persistent client while operating disconnected(offline). The default value is 10000 (10MB).

Parameters:: size - maximum size of the local store (in Kilobytes).
See Also:: setEnableLocalStoreBoolean(Boolean), isEnableLocalStoreBoolean(), setLocalStoreDirectory(String), getLocalStoreDirectory(), getLocalStoreSizeLong(), setReconnectTimeoutInteger(Integer), getReconnectTimeoutInteger(), setReconnectIntervalInteger(Integer), getReconnectIntervalInteger(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

getLocalStoreSize

public long getLocalStoreSize()

Get limit on how many messages can be stored locally on the persistent client while operating disconnected(offline). The default value is 10000 (10MB).

Returns:: maximum size of the local store (in Kilobytes) as a long.
See Also:: setEnableLocalStore(boolean), isEnableLocalStore(), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSize(long), setReconnectTimeout(int), getReconnectTimeout(), setReconnectInterval(int), getReconnectInterval(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

getLocalStoreSizeLong

public java.lang.Long getLocalStoreSizeLong()

Get limit on how many messages can be stored locally on the persistent client while operating disconnected(offline). The default value is 10000 (10MB).

Returns:: maximum size of the local store (in Kilobytes) as a Long.
See Also:: setEnableLocalStoreBoolean(Boolean), isEnableLocalStoreBoolean(), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSizeLong(Long), setReconnectTimeoutInteger(Integer), getReconnectTimeoutInteger(), setReconnectIntervalInteger(Integer), getReconnectIntervalInteger(), setLocalStoreWaitTime(Integer), getLocalStoreWaitTime()

setLocalStoreWaitTime

public void setLocalStoreWaitTime(java.lang.Integer secs)

Sets the limit (in seconds) on how long a sender send call waits before the message is written to the local store. The default is 0 (no limit).

Parameters:: secs - time to wait (in seconds)
See Also:: setEnableLocalStoreBoolean(Boolean), isEnableLocalStoreBoolean(), setLocalStoreDirectory(String), getLocalStoreDirectory(), getLocalStoreSizeLong(), setReconnectTimeoutInteger(Integer), getReconnectTimeoutInteger(), setReconnectIntervalInteger(Integer), getReconnectIntervalInteger(), getLocalStoreWaitTime()

getLocalStoreWaitTime

public java.lang.Integer getLocalStoreWaitTime()

Gets the limit (in seconds) on how long a sender send call waits before the message is written to the local store. The default is 0 (no limit).

Returns:: the wait time (in seconds) as an Integer.
See Also:: setEnableLocalStoreBoolean(Boolean), isEnableLocalStoreBoolean(), setLocalStoreDirectory(String), getLocalStoreDirectory(), setLocalStoreSizeLong(Long), setReconnectTimeoutInteger(Integer), getReconnectTimeoutInteger(), setReconnectIntervalInteger(Integer), getReconnectIntervalInteger(), setLocalStoreWaitTime(Integer)