org.apache.qpid.jms

Class JmsConnectionFactory

java.lang.Object

org.apache.qpid.jms.jndi.JNDIStorable

org.apache.qpid.jms.JmsConnectionFactory

All Implemented Interfaces:

Externalizable, Serializable, javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory, Referenceable

public class JmsConnectionFactory
extends JNDIStorable
implements javax.jms.ConnectionFactory, javax.jms.QueueConnectionFactory, javax.jms.TopicConnectionFactory

JMS ConnectionFactory Implementation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	REMOTE_URI_PROP

Constructor Summary

Constructors

Constructor and Description
JmsConnectionFactory()
JmsConnectionFactory(String remoteURI)
JmsConnectionFactory(String username, String password)
JmsConnectionFactory(String userName, String password, String remoteURI)
JmsConnectionFactory(String userName, String password, URI remoteURI)
JmsConnectionFactory(URI remoteURI)

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,String>	buildFromProperties(Map<String,String> props) Set the properties that will represent the instance in JNDI
protected <T extends JmsConnection> T	configureConnection(T connection, String username, String password)
javax.jms.Connection	createConnection()
javax.jms.Connection	createConnection(String username, String password)
protected Provider	createProvider(URI remoteURI)
javax.jms.QueueConnection	createQueueConnection()
javax.jms.QueueConnection	createQueueConnection(String username, String password)
javax.jms.TopicConnection	createTopicConnection()
javax.jms.TopicConnection	createTopicConnection(String username, String password)
protected static URI	createURI(String name)
String	getClientID()
protected IdGenerator	getClientIdGenerator()
String	getClientIDPrefix()
long	getCloseTimeout() Gets the currently set close timeout.
protected IdGenerator	getConnectionIdGenerator()
long	getConnectTimeout() Returns the currently configured wire level connect timeout.
javax.jms.ExceptionListener	getExceptionListener() Gets the currently configured JMS ExceptionListener that will be set on all new Connection objects created from this factory.
JmsMessageIDBuilder	getMessageIDBuilder()
String	getMessageIDType()
String	getPassword()
JmsPrefetchPolicy	getPrefetchPolicy()
String	getQueuePrefix() Returns the prefix applied to Queues that are created by the client.
JmsRedeliveryPolicy	getRedeliveryPolicy() Returns the JmsRedeliveryPolicy that is applied when a new connection is created.
String	getRemoteURI()
long	getRequestTimeout()
long	getSendTimeout()
String	getTopicPrefix() Returns the prefix applied to Topics that are created by the client.
String	getUsername()
boolean	isAlwaysSyncSend() Returns true if the client should always send messages using a synchronous send operation regardless of persistence mode, or inside a transaction.
boolean	isForceAsyncSend()
boolean	isLocalMessageExpiry()
boolean	isLocalMessagePriority()
boolean	isReceiveLocalOnly()
boolean	isReceiveNoWaitLocalOnly()
boolean	isSendAcksAsync()
boolean	isValidatePropertyNames()
protected void	populateProperties(Map<String,String> props) Initialize the instance from properties stored in JNDI
void	setAlwaysSyncSend(boolean alwaysSyncSend) Configures whether or not the client will always send messages synchronously or not regardless of other factors that might result in an asynchronous send.
void	setClientID(String clientID) Sets the JMS clientID to use for connections created by this factory.
protected void	setClientIdGenerator(IdGenerator clientIdGenerator)
void	setClientIDPrefix(String clientIDPrefix) Sets the prefix used by auto-generated JMS Client ID values which are used if the JMS client does not explicitly specify one.
void	setCloseTimeout(long closeTimeout) Sets the close timeout used to control how long a Connection close will wait for clean shutdown of the connection before giving up.
protected void	setConnectionIdGenerator(IdGenerator connectionIdGenerator)
void	setConnectionIDPrefix(String connectionIDPrefix) Sets the prefix used by connection id generator.
void	setConnectTimeout(long connectTimeout) Sets the timeout value used to control how long a client will wait for a successful connection to the remote peer to be established before considering the attempt to have failed.
void	setExceptionListener(javax.jms.ExceptionListener exceptionListener) Sets the JMS ExceptionListener that will be set on all new Connection objects created from this factory.
void	setForceAsyncSend(boolean forceAsyncSend)
void	setLocalMessageExpiry(boolean localMessageExpiry) Controls whether message expiration checking is done locally (in addition to any broker side checks) in each MessageConsumer prior to dispatching a message.
void	setLocalMessagePriority(boolean localMessagePriority) Enables client-side message priority support in MessageConsumer instances.
void	setMessageIDBuilder(JmsMessageIDBuilder messageIDBuilder) Allows the owner of this factory to configure a custom Message ID Builder instance that will be used to create the Message ID values set in outgoing Messages sent from MessageProducer instances.
void	setMessageIDType(String type) Sets the type of the Message IDs used to populate the outgoing Messages
void	setPassword(String password)
void	setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy)
void	setQueuePrefix(String queuePrefix)
void	setReceiveLocalOnly(boolean receiveLocalOnly) Controls whether the client only checks its local message buffer when using receive calls with a timeout, or will instead drain remaining credit from the remote peer to ensure there are really no messages available if the timeout expires before a message arrives in the consumers local buffer.
void	setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly) Controls whether the client only checks its local message buffer when using receiveNoWait calls, or will instead drain remaining credit from the remote peer synchronously to ensure there are really no messages available that have yet to arrive in the consumers local buffer.
void	setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy) Sets the JmsRedeliveryPolicy that is applied when a new connection is created.
void	setRemoteURI(String remoteURI)
void	setRequestTimeout(long requestTimeout)
void	setSendAcksAsync(boolean sendAcksAsync) Should the message acknowledgments from a consumer be sent synchronously or asynchronously.
void	setSendTimeout(long sendTimeout)
void	setTopicPrefix(String topicPrefix)
void	setUsername(String username)
void	setValidatePropertyNames(boolean validatePropertyNames)

Methods inherited from class org.apache.qpid.jms.jndi.JNDIStorable

getProperties, getProperty, getReference, readExternal, setProperties, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_URI_PROP

public static final String REMOTE_URI_PROP

See Also:

Constant Field Values

Constructor Detail

JmsConnectionFactory

public JmsConnectionFactory()

JmsConnectionFactory

public JmsConnectionFactory(String username,
                    String password)

JmsConnectionFactory

public JmsConnectionFactory(String remoteURI)

JmsConnectionFactory

public JmsConnectionFactory(URI remoteURI)

JmsConnectionFactory

public JmsConnectionFactory(String userName,
                    String password,
                    URI remoteURI)

JmsConnectionFactory

public JmsConnectionFactory(String userName,
                    String password,
                    String remoteURI)

Method Detail

buildFromProperties

protected Map<String,String> buildFromProperties(Map<String,String> props)

Description copied from class: JNDIStorable

Set the properties that will represent the instance in JNDI

Specified by:

buildFromProperties in class JNDIStorable

Returns:

a new, unmodifiable, map containing any unused properties, or empty if none were.

populateProperties

protected void populateProperties(Map<String,String> props)

Description copied from class: JNDIStorable

Initialize the instance from properties stored in JNDI

Specified by:

populateProperties in class JNDIStorable

createTopicConnection

public javax.jms.TopicConnection createTopicConnection()
                                                throws javax.jms.JMSException

Specified by:

createTopicConnection in interface javax.jms.TopicConnectionFactory

Throws:

javax.jms.JMSException

createTopicConnection

public javax.jms.TopicConnection createTopicConnection(String username,
                                              String password)
                                                throws javax.jms.JMSException

Specified by:

createTopicConnection in interface javax.jms.TopicConnectionFactory

Throws:

javax.jms.JMSException

createConnection

public javax.jms.Connection createConnection()
                                      throws javax.jms.JMSException

Specified by:

createConnection in interface javax.jms.ConnectionFactory

Throws:

javax.jms.JMSException

createConnection

public javax.jms.Connection createConnection(String username,
                                    String password)
                                      throws javax.jms.JMSException

Specified by:

createConnection in interface javax.jms.ConnectionFactory

Throws:

javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection()
                                                throws javax.jms.JMSException

Specified by:

createQueueConnection in interface javax.jms.QueueConnectionFactory

Throws:

javax.jms.JMSException

createQueueConnection

public javax.jms.QueueConnection createQueueConnection(String username,
                                              String password)
                                                throws javax.jms.JMSException

Specified by:

createQueueConnection in interface javax.jms.QueueConnectionFactory

Throws:

javax.jms.JMSException

configureConnection

protected <T extends JmsConnection> T configureConnection(T connection,
                                              String username,
                                              String password)
                                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createProvider

protected Provider createProvider(URI remoteURI)
                           throws Exception

Throws:

Exception

createURI

protected static URI createURI(String name)

getConnectionIdGenerator

protected IdGenerator getConnectionIdGenerator()

setConnectionIdGenerator

protected void setConnectionIdGenerator(IdGenerator connectionIdGenerator)

getRemoteURI

public String getRemoteURI()

Returns:

the remoteURI

setRemoteURI

public void setRemoteURI(String remoteURI)

Parameters:

remoteURI - the remoteURI to set

getUsername

public String getUsername()

Returns:

the user name used for connection authentication.

setUsername

public void setUsername(String username)

Parameters:

username - the user name to set

getPassword

public String getPassword()

Returns:

the password set for connection authentication.

setPassword

public void setPassword(String password)

Parameters:

password - the password to set

isForceAsyncSend

public boolean isForceAsyncSend()

setForceAsyncSend

public void setForceAsyncSend(boolean forceAsyncSend)

isLocalMessagePriority

public boolean isLocalMessagePriority()

Returns:

the localMessagePriority configuration option.

setLocalMessagePriority

public void setLocalMessagePriority(boolean localMessagePriority)

Enables client-side message priority support in MessageConsumer instances. This results in all prefetched messages being dispatched in priority order.

Parameters:

localMessagePriority - the messagePrioritySupported to set

getQueuePrefix

public String getQueuePrefix()

Returns the prefix applied to Queues that are created by the client.

Returns:

the currently configured Queue prefix.

setQueuePrefix

public void setQueuePrefix(String queuePrefix)

getTopicPrefix

public String getTopicPrefix()

Returns the prefix applied to Topics that are created by the client.

Returns:

the currently configured Topic prefix.

setTopicPrefix

public void setTopicPrefix(String topicPrefix)

isValidatePropertyNames

public boolean isValidatePropertyNames()

setValidatePropertyNames

public void setValidatePropertyNames(boolean validatePropertyNames)

getCloseTimeout

public long getCloseTimeout()

Gets the currently set close timeout.

Returns:

the currently set close timeout.

setCloseTimeout

public void setCloseTimeout(long closeTimeout)

Sets the close timeout used to control how long a Connection close will wait for clean shutdown of the connection before giving up. A negative value means wait forever. Care should be taken in that a very short close timeout can cause the client to not cleanly shutdown the connection and it's resources.

Parameters:

closeTimeout - time in milliseconds to wait for a clean connection close.

getConnectTimeout

public long getConnectTimeout()

Returns the currently configured wire level connect timeout.

Returns:

the currently configured wire level connect timeout.

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

Sets the timeout value used to control how long a client will wait for a successful connection to the remote peer to be established before considering the attempt to have failed. This value does not control socket level connection timeout but rather connection handshake at the wire level, to control the socket level timeouts use the standard socket options configuration values.

Parameters:

connectTimeout - the time in milliseconds to wait for the protocol connection handshake to complete.

getSendTimeout

public long getSendTimeout()

setSendTimeout

public void setSendTimeout(long sendTimeout)

getRequestTimeout

public long getRequestTimeout()

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

getPrefetchPolicy

public JmsPrefetchPolicy getPrefetchPolicy()

setPrefetchPolicy

public void setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy)

getRedeliveryPolicy

public JmsRedeliveryPolicy getRedeliveryPolicy()

Returns the JmsRedeliveryPolicy that is applied when a new connection is created.

Returns:

the redeliveryPolicy that is currently configured for this factory.

setRedeliveryPolicy

public void setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy)

Sets the JmsRedeliveryPolicy that is applied when a new connection is created.

Parameters:

redeliveryPolicy - The new redeliveryPolicy to set

getClientIDPrefix

public String getClientIDPrefix()

Returns:

the currently configured client ID prefix for auto-generated client IDs.

setClientIDPrefix

public void setClientIDPrefix(String clientIDPrefix)

Sets the prefix used by auto-generated JMS Client ID values which are used if the JMS client does not explicitly specify one.

Parameters:

clientIDPrefix - the value to use as a prefix on auto-generated client IDs.

getClientIdGenerator

protected IdGenerator getClientIdGenerator()

setClientIdGenerator

protected void setClientIdGenerator(IdGenerator clientIdGenerator)

getClientID

public String getClientID()

setClientID

public void setClientID(String clientID)

Sets the JMS clientID to use for connections created by this factory. NOTE: A clientID can only be used by one Connection at a time, so setting it here will restrict the ConnectionFactory to creating a single open Connection at a time. It is possible to set the clientID on the Connection itself immediately after creation if no value has been set via the factory that created it, which will allow the factory to create multiple open connections at a time.

Parameters:

clientID - The clientID to assign when creating a new connection.

setConnectionIDPrefix

public void setConnectionIDPrefix(String connectionIDPrefix)

Sets the prefix used by connection id generator.

Parameters:

connectionIDPrefix - The string prefix used on all connection Id's created by this factory.

getExceptionListener

public javax.jms.ExceptionListener getExceptionListener()

Gets the currently configured JMS ExceptionListener that will be set on all new Connection objects created from this factory. NOTE: the listener object is not saved when serializing the factory.

Returns:

the currently configured JMS ExceptionListener.

setExceptionListener

public void setExceptionListener(javax.jms.ExceptionListener exceptionListener)

Sets the JMS ExceptionListener that will be set on all new Connection objects created from this factory.

Parameters:

exceptionListener - the JMS ExceptionListener to apply to new Connection's or null to clear.

isAlwaysSyncSend

public boolean isAlwaysSyncSend()

Returns true if the client should always send messages using a synchronous send operation regardless of persistence mode, or inside a transaction.

Returns:

true if sends should always be done synchronously.

setAlwaysSyncSend

public void setAlwaysSyncSend(boolean alwaysSyncSend)

Configures whether or not the client will always send messages synchronously or not regardless of other factors that might result in an asynchronous send.

Parameters:

alwaysSyncSend - if true sends are always done synchronously.

isSendAcksAsync

public boolean isSendAcksAsync()

Returns:

true if consumer acknowledgments are sent asynchronously or not.

setSendAcksAsync

public void setSendAcksAsync(boolean sendAcksAsync)

Should the message acknowledgments from a consumer be sent synchronously or asynchronously. Sending the acknowledgments asynchronously can increase the performance of a consumer but opens up the possibility of a missed message acknowledge should the connection be unstable.

Parameters:

sendAcksAsync - true to have the client send all message acknowledgments asynchronously.

isLocalMessageExpiry

public boolean isLocalMessageExpiry()

Returns:

true if MessageConsumer instance will check for expired messages locally before dispatch.

setLocalMessageExpiry

public void setLocalMessageExpiry(boolean localMessageExpiry)

Controls whether message expiration checking is done locally (in addition to any broker side checks) in each MessageConsumer prior to dispatching a message. Disabling this check can lead to consumption of expired messages.

Parameters:

localMessageExpiry - controls whether expiration checking is done prior to dispatch.

setMessageIDType

public void setMessageIDType(String type)

Sets the type of the Message IDs used to populate the outgoing Messages

Parameters:

type - The name of the Message type to use when sending a message.

getMessageIDType

public String getMessageIDType()

getMessageIDBuilder

public JmsMessageIDBuilder getMessageIDBuilder()

Returns:

the messageIDBuilder currently configured.

setMessageIDBuilder

public void setMessageIDBuilder(JmsMessageIDBuilder messageIDBuilder)

Allows the owner of this factory to configure a custom Message ID Builder instance that will be used to create the Message ID values set in outgoing Messages sent from MessageProducer instances.

Parameters:

messageIDBuilder - The custom JmsMessageIDBuilder to use to create outgoing Message IDs.

isReceiveLocalOnly

public boolean isReceiveLocalOnly()

setReceiveLocalOnly

public void setReceiveLocalOnly(boolean receiveLocalOnly)

Controls whether the client only checks its local message buffer when using receive calls with a timeout, or will instead drain remaining credit from the remote peer to ensure there are really no messages available if the timeout expires before a message arrives in the consumers local buffer.

Parameters:

receiveLocalOnly - true if receive calls with a timeout should only check the local message buffer.

isReceiveNoWaitLocalOnly

public boolean isReceiveNoWaitLocalOnly()

setReceiveNoWaitLocalOnly

public void setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly)

Controls whether the client only checks its local message buffer when using receiveNoWait calls, or will instead drain remaining credit from the remote peer synchronously to ensure there are really no messages available that have yet to arrive in the consumers local buffer.

Parameters:

receiveNoWaitLocalOnly - true if receiveNoWait calls should only check the local message buffer.