progress.message.jclient
Class QueueConnectionFactory

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

All Implemented Interfaces:

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

Direct Known Subclasses:

XAQueueConnectionFactory

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

An implementation of a JMS QueueConnectionFactory. A client uses a QueueConnectionFactory to create QueueConnections with a JMS PTP provider.

Version:

1.0 - July 1999

Author:

May Hsu

See Also:

QueueConnectionFactory, 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, PING_INTERVAL, RECONNECT_INTERVAL, RECONNECT_TIMEOUT, SOCKET_CONNECT_TIMEOUT, SSL, TCP

Constructor Summary

QueueConnectionFactory()
Construct a QueueConnectionFactory with the default URL

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

QueueConnectionFactory(java.lang.String brokerHostName, int brokerPort, java.lang.String brokerProtocol, java.lang.String defaultUserName, java.lang.String defaultPassword)
Construct a QueueConnectionFactory (with a default connectID of null).

QueueConnectionFactory(java.lang.String brokerHostName, int brokerPort, java.lang.String brokerProtocol, java.lang.String connectID, java.lang.String defaultUserName, java.lang.String defaultPassword)
Construct a QueueConnectionFactory.

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

QueueConnectionFactory(java.lang.String brokerURL, java.lang.String defaultUserName, java.lang.String defaultPassword)
Construct a QueueConnectionFactory (with a default connectID of null).

QueueConnectionFactory(java.lang.String brokerURL, java.lang.String connectID, java.lang.String defaultUserName, java.lang.String defaultPassword)
Construct a QueueConnectionFactory.

Method Summary

QueueConnection	createQueueConnection() Create a queue connection with default user identity.
QueueConnection	createQueueConnection(java.lang.String userName, java.lang.String password) Create a queue connection with specified user identity.
javax.naming.Reference	getReference() Return a javax.naming.Reference object which contains the reference information necessary to create an object of the proper type.

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, 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, 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

Methods inherited from interface javax.jms.ConnectionFactory

createConnection, createConnection

Constructor Detail

QueueConnectionFactory

public QueueConnectionFactory()
                       throws JMSException

Construct a QueueConnectionFactory with the default URL

Throws:

JMSException

QueueConnectionFactory

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

Construct a QueueConnectionFactory (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.

QueueConnectionFactory

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

Construct a QueueConnectionFactory (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.

QueueConnectionFactory

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

Construct a QueueConnectionFactory (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.

QueueConnectionFactory

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

Construct a QueueConnectionFactory.

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.

QueueConnectionFactory

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

Construct a QueueConnectionFactory (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.

QueueConnectionFactory

public QueueConnectionFactory(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 QueueConnectionFactory.

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

createQueueConnection

public QueueConnection createQueueConnection()
                                      throws JMSException

Create a queue connection with default user identity.

Specified by:

createQueueConnection in interface QueueConnectionFactory

Returns:

a newly created queue connection.

Throws:

JMSException - if JMS Provider fails to create a Queue Connection due to some internal error.

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

createQueueConnection

public QueueConnection createQueueConnection(java.lang.String userName,
                                             java.lang.String password)
                                      throws JMSException

Create a queue connection with specified user identity.

Specified by:

createQueueConnection in interface QueueConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created queue connection.

Throws:

JMSException - if JMS Provider fails to create a Queue Connection due to some internal error.

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

getReference

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

Return a javax.naming.Reference object which contains the reference information necessary to create an object of the proper type.

Specified by:

getReference in interface javax.naming.Referenceable

Overrides:

getReference in class ConnectionFactory

Returns:

the Reference object, which contains information to create the desired object.

Throws:

javax.naming.NamingException - if the object naming is invalid.