progress.message.jclient.xa
Class XAConnectionFactory

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

All Implemented Interfaces:

java.io.Serializable, ConnectionFactory, XAConnectionFactory, javax.naming.Referenceable

public class XAConnectionFactory
extends ConnectionFactory
implements XAConnectionFactory

See Also:

Serialized Form

Field Summary

Fields inherited from class progress.message.jclient.ConnectionFactory

ASYNCHRONOUS_DELIVERY_MODE_DEFAULT, CLIENT_TRANSACTION_BUFFER_SIZE, COMPRESSION_FACTORY, COMPRESSION_METRICS_LISTENER, DELIVERY_CLOSE_TIMEOUT_DEFAULT, DELIVERY_DOUBT_WINDOW_DEFAULT, ENABLE_COMPRESSION, ENABLE_LOCAL_STORE, FAULT_TOLERANT, FAULT_TOLERANT_RECONNECT_TIMEOUT, FLOW_TO_DISK, HTTP, INITIAL_CONNECT_TIMEOUT, LG_DOWN_STREAM_NODE_TYPE, LG_ENABLED, LOCAL_STORE_DIRECTORY, LOCAL_STORE_LISTENER_FACTORY_CLASS, LOCAL_STORE_SIZE, LOCAL_STORE_WAIT_TIME, LOGIN_SPI_OBJECT, MINIMIZE_SUBSCRIBER_TRAFFIC, PING_INTERVAL, RECONNECT_INTERVAL, RECONNECT_TIMEOUT, SOCKET_CONNECT_TIMEOUT, SSL, TCP

Constructor Summary

XAConnectionFactory()
Construct an XAQueueConnectionFactory connecting to the broker at localhost, with a default connectID, user and password of "".

XAConnectionFactory(java.lang.String brokerURL)
Construct an XAQueueConnectionFactory (with a default connectID, user and password of "").

XAConnectionFactory(java.lang.String brokerURL, java.lang.String connectID, java.lang.String userName, java.lang.String password)
Construct an XAConnectionFactory.

Method Summary

XAConnection	createXAConnection() Creates an XAConnection with the default user identity.
XAConnection	createXAConnection(java.lang.String userName, java.lang.String password) Creates an XA connection with the specified user identity.
java.lang.String	getPassword() Get password.
javax.naming.Reference	getReference() Retrieves the Reference of this object.
java.lang.String	getUserName() Get User Name.
void	setPassword(java.lang.String password) Set password.
void	setUserName(java.lang.String username) Set user name.

Methods inherited from class progress.message.jclient.ConnectionFactory

createConnection, createConnection, getApplet, getAsynchronousDeliveryMode, getBrokerHostName, getBrokerPort, getBrokerProtocol, getBrokerURL, getClientID, getClientTransactionBufferSize, getCompressionFactory, getConnectID, getConnectionURLs, getDefaultPassword, getDefaultTxnBatchSize, getDefaultTxnBatchSizeInteger, getDefaultUser, getDeliveryCloseTimeout, getDeliveryDoubtWindow, getDurableMessageOrder, getEnableActionalInstrumentation, getEnableActionalInstrumentationBoolean, getEnableCompression, getEnableCompressionBoolean, getFaultTolerant, getFaultTolerantReconnectTimeout, getFlowToDisk, getInitialConnectTimeout, getInitialRcvBufferSize, getInitialSendBufferSize, getLGDownStreamNodeType, getLoadBalancing, getLoadBalancingBoolean, getLoadBalancingClientData, getLocalStoreDirectory, getLocalStoreSize, getLocalStoreSizeLong, getLocalStoreWaitTime, getLoginSPI, getMaxDeliveryCount, getMaxRcvBufferSize, getMaxSendBufferSize, getMinimizeSubscriberTraffic, getMinimizeSubscriberTrafficBoolean, getMinRcvBufferSize, getMinSendBufferSize, getMonitorInterval, getPersistentDelivery, getPersistentDeliveryBoolean, getPingInterval, getPingIntervalLong, getPrefetchCount, getPrefetchCountInteger, getPrefetchThreshold, getPrefetchThresholdInteger, getQopCacheSize, getReconnectInterval, getReconnectIntervalInteger, getReconnectTimeout, getReconnectTimeoutInteger, getRequireActionalJMSNode, getRequireActionalJMSNodeBoolean, getRethrowCCRuntimeExceptions, getSelectorAtBroker, getSequential, getSequentialBoolean, getSocketConnectTimeout, getSplitMultiTopicDelivery, getUrlsOrUrl, isEnableLocalStore, isEnableLocalStoreBoolean, setApplet, setAsynchronousDeliveryMode, setBrokerHostName, setBrokerPort, setBrokerProtocol, setBrokerURL, setClientID, setClientTransactionBufferSize, setCompressionFactory, setConnectID, setConnectionURLs, setDefaultPassword, setDefaultTxnBatchSize, setDefaultTxnBatchSizeInteger, setDefaultUser, setDeliveryCloseTimeout, setDeliveryDoubtWindow, setDurableMessageOrder, setEnableActionalInstrumentation, setEnableActionalInstrumentationBoolean, setEnableCompression, setEnableCompressionBoolean, setEnableLocalStore, setEnableLocalStoreBoolean, setFaultTolerant, setFaultTolerantReconnectTimeout, setFlowToDisk, setInitialConnectTimeout, setInitialRcvBufferSize, setInitialSendBufferSize, setLGDownStreamNodeType, setLoadBalancing, setLoadBalancingBoolean, setLoadBalancingClientData, setLocalStoreDirectory, setLocalStoreSize, setLocalStoreSizeLong, setLocalStoreWaitTime, setLoginSPI, setMaxDeliveryCount, setMaxRcvBufferSize, setMaxSendBufferSize, setMinimizeSubscriberTraffic, setMinimizeSubscriberTrafficBoolean, setMinRcvBufferSize, setMinSendBufferSize, setMonitorInterval, setPersistentDelivery, setPersistentDeliveryBoolean, setPingInterval, setPingIntervalLong, setPrefetchCount, setPrefetchCountInteger, setPrefetchThreshold, setPrefetchThresholdInteger, setQopCacheSize, setReconnectInterval, setReconnectIntervalInteger, setReconnectTimeout, setReconnectTimeoutInteger, setRequireActionalJMSNode, setRequireActionalJMSNodeBoolean, setRethrowCCRuntimeExceptions, setSelectorAtBroker, setSequential, setSequentialBoolean, setSocketConnectTimeout, setSplitMultiTopicDelivery

Methods inherited from class java.lang.Object

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

Constructor Detail

XAConnectionFactory

public XAConnectionFactory()
                    throws JMSException

Construct an XAQueueConnectionFactory connecting to the broker at localhost, with a default connectID, user and password of "".

Throws:

JMSException - if a XA connection factory can not be created.

XAConnectionFactory

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

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

Parameters:

brokerURL - the URL (in the form [protocol://]hostname[:port]) of the message broker to which XA connection are made.

Throws:

JMSException - if a XA connection factory can not be created.

XAConnectionFactory

public XAConnectionFactory(java.lang.String brokerURL,
                           java.lang.String connectID,
                           java.lang.String userName,
                           java.lang.String password)
                    throws JMSException

Construct an XAConnectionFactory.

Parameters:

brokerURL - the URL (in the form [protocol://]hostname[:port]) of the message broker to which XA connection are made.

connectID - the id string used to identify the regular connection and the coresponding XAQueueConnection with a system assigned prefix. This may be null.

userName - the default user name

password - the default password

Throws:

JMSException - if a connection factory can not be created.

Method Detail

createXAConnection

public XAConnection createXAConnection()
                                throws JMSException

Creates an XAConnection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createXAConnection in interface XAConnectionFactory

Returns:

a newly created XAConnection

Throws:

JMSException - if the JMS provider fails to create an XA connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

Since:

1.1

createXAConnection

public XAConnection createXAConnection(java.lang.String userName,
                                       java.lang.String password)
                                throws JMSException

Creates an XA connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createXAConnection in interface XAConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created XA connection

Throws:

JMSException - if the JMS provider fails to create an XA connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

Since:

1.1

getUserName

public java.lang.String getUserName()

Get User Name.

Returns:

the user name.

getPassword

public java.lang.String getPassword()

Get password.

Returns:

the password.

setUserName

public void setUserName(java.lang.String username)

Set user name.

Parameters:

username - the user name.

setPassword

public void setPassword(java.lang.String password)

Set password.

Parameters:

password - the password.

getReference

public javax.naming.Reference getReference()
                                    throws javax.naming.NamingException

Retrieves the Reference of this object.

Specified by:

getReference in interface javax.naming.Referenceable

Overrides:

getReference in class ConnectionFactory

Returns:

The non-null Reference of this object.

Throws:

javax.naming.NamingException - If a naming exception was encountered while retrieving the reference.