Package org.apache.qpid.jms.meta

Class JmsConnectionInfo

java.lang.Object

org.apache.qpid.jms.meta.JmsAbstractResource

org.apache.qpid.jms.meta.JmsConnectionInfo

All Implemented Interfaces:

Comparable<JmsConnectionInfo>, JmsResource

public final class JmsConnectionInfo
extends JmsAbstractResource
implements Comparable<JmsConnectionInfo>

Meta object that contains the JmsConnection identification and configuration options. Providers can extend this to add Provider specific data as needed.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.jms.meta.JmsResource

JmsResource.ResourceState

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_CLOSE_TIMEOUT
static long	DEFAULT_CONNECT_TIMEOUT
static long	DEFAULT_REQUEST_TIMEOUT
static long	DEFAULT_SEND_TIMEOUT
static long	INFINITE

Constructor Summary

Constructors

Constructor	Description
JmsConnectionInfo(JmsConnectionId connectionId)

Method Summary

Modifier and Type	Method	Description
int	compareTo(JmsConnectionInfo other)
JmsConnectionInfo	copy()
boolean	equals(Object obj)
String	getClientId()
long	getCloseTimeout()
URI	getConfiguredURI()
URI	getConnectedURI()
JmsConnection	getConnection()
long	getConnectTimeout()
JmsDeserializationPolicy	getDeserializationPolicy()
byte[]	getEncodedUsername()
EnumMap<JmsConnectionExtensions,BiFunction<javax.jms.Connection,URI,Object>>	getExtensionMap()
JmsConnectionId	getId()	Returns the assigned resource ID for this JmsResource instance.
JmsMessageIDPolicy	getMessageIDPolicy()
String	getPassword()
JmsPrefetchPolicy	getPrefetchPolicy()
JmsPresettlePolicy	getPresettlePolicy()
String	getQueuePrefix()
JmsRedeliveryPolicy	getRedeliveryPolicy()
long	getRequestTimeout()
long	getSendTimeout()
String	getTopicPrefix()
JmsTracer	getTracer()
String	getUsername()
int	hashCode()
boolean	isAwaitClientID()
boolean	isCloseLinksThatFailOnReconnect()
boolean	isExplicitClientID()
boolean	isForceAsyncAcks()
boolean	isForceAsyncSend()
boolean	isForceSyncSend()
boolean	isLocalMessageExpiry()
boolean	isLocalMessagePriority()
boolean	isPopulateJMSXUserID()
boolean	isReceiveLocalOnly()
boolean	isReceiveNoWaitLocalOnly()
boolean	isUseDaemonThread()
boolean	isValidatePropertyNames()
boolean	isValidateSelector()
void	setAwaitClientID(boolean awaitClientID)
void	setClientId(String clientId, boolean explicitClientID)
void	setCloseLinksThatFailOnReconnect(boolean closeLinksThatFailOnReconnect)
void	setCloseTimeout(long closeTimeout)
void	setConfiguredURI(URI uri)
void	setConnectedURI(URI connectedURI)
void	setConnection(JmsConnection connection)
void	setConnectTimeout(long connectTimeout)
void	setDeserializationPolicy(JmsDeserializationPolicy deserializationPolicy)
void	setForceAsyncAcks(boolean forceAsyncAcks)
void	setForceAsyncSend(boolean forceAsyncSend)
void	setForceSyncSend(boolean forceSyncSend)
void	setLocalMessageExpiry(boolean localMessageExpiry)
void	setLocalMessagePriority(boolean localMessagePriority)
void	setMessageIDPolicy(JmsMessageIDPolicy messageIDPolicy)
void	setPassword(String password)
void	setPopulateJMSXUserID(boolean populateMessageUserID)
void	setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy)
void	setPresettlePolicy(JmsPresettlePolicy presettlePolicy)
void	setQueuePrefix(String queuePrefix)
void	setReceiveLocalOnly(boolean receiveLocalOnly)
void	setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly)
void	setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy)
void	setRequestTimeout(long requestTimeout)
void	setSendTimeout(long sendTimeout)
void	setTopicPrefix(String topicPrefix)
void	setTracer(JmsTracer tracer)
void	setUseDaemonThread(boolean useDaemonThread)
void	setUsername(String username)
void	setValidatePropertyNames(boolean validatePropertyNames)
void	setValidateSelector(boolean validateSelector)
String	toString()
void	visit(JmsResourceVistor vistor)	Allows a visitor object to walk the resources and process them.

Methods inherited from class org.apache.qpid.jms.meta.JmsAbstractResource

getState, isClosed, setState

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INFINITE

public static final long INFINITE

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final long DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CLOSE_TIMEOUT

public static final long DEFAULT_CLOSE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SEND_TIMEOUT

public static final long DEFAULT_SEND_TIMEOUT

See Also:

Constant Field Values

DEFAULT_REQUEST_TIMEOUT

public static final long DEFAULT_REQUEST_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

JmsConnectionInfo

public JmsConnectionInfo(JmsConnectionId connectionId)

Method Detail

copy

public JmsConnectionInfo copy()

isForceAsyncSend

public boolean isForceAsyncSend()

setForceAsyncSend

public void setForceAsyncSend(boolean forceAsyncSend)

isForceSyncSend

public boolean isForceSyncSend()

setForceSyncSend

public void setForceSyncSend(boolean forceSyncSend)

getId

public JmsConnectionId getId()

Description copied from interface: JmsResource

Returns the assigned resource ID for this JmsResource instance.

Specified by:

getId in interface JmsResource

Returns:

the assigned resource ID for this JmsResource instance.

getConfiguredURI

public URI getConfiguredURI()

setConfiguredURI

public void setConfiguredURI(URI uri)

getConnectedURI

public URI getConnectedURI()

setConnectedURI

public void setConnectedURI(URI connectedURI)

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId,
                        boolean explicitClientID)

isExplicitClientID

public boolean isExplicitClientID()

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getQueuePrefix

public String getQueuePrefix()

setQueuePrefix

public void setQueuePrefix(String queuePrefix)

getTopicPrefix

public String getTopicPrefix()

setTopicPrefix

public void setTopicPrefix(String topicPrefix)

isValidatePropertyNames

public boolean isValidatePropertyNames()

setValidatePropertyNames

public void setValidatePropertyNames(boolean validatePropertyNames)

isValidateSelector

public boolean isValidateSelector()

setValidateSelector

public void setValidateSelector(boolean validateSelector)

getCloseTimeout

public long getCloseTimeout()

setCloseTimeout

public void setCloseTimeout(long closeTimeout)

getConnectTimeout

public long getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

getSendTimeout

public long getSendTimeout()

setSendTimeout

public void setSendTimeout(long sendTimeout)

getRequestTimeout

public long getRequestTimeout()

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

isLocalMessagePriority

public boolean isLocalMessagePriority()

setLocalMessagePriority

public void setLocalMessagePriority(boolean localMessagePriority)

isForceAsyncAcks

public boolean isForceAsyncAcks()

setForceAsyncAcks

public void setForceAsyncAcks(boolean forceAsyncAcks)

isReceiveLocalOnly

public boolean isReceiveLocalOnly()

setReceiveLocalOnly

public void setReceiveLocalOnly(boolean receiveLocalOnly)

isReceiveNoWaitLocalOnly

public boolean isReceiveNoWaitLocalOnly()

setReceiveNoWaitLocalOnly

public void setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly)

isLocalMessageExpiry

public boolean isLocalMessageExpiry()

setLocalMessageExpiry

public void setLocalMessageExpiry(boolean localMessageExpiry)

getPrefetchPolicy

public JmsPrefetchPolicy getPrefetchPolicy()

setPrefetchPolicy

public void setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy)

getRedeliveryPolicy

public JmsRedeliveryPolicy getRedeliveryPolicy()

setRedeliveryPolicy

public void setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy)

getPresettlePolicy

public JmsPresettlePolicy getPresettlePolicy()

setPresettlePolicy

public void setPresettlePolicy(JmsPresettlePolicy presettlePolicy)

getMessageIDPolicy

public JmsMessageIDPolicy getMessageIDPolicy()

setMessageIDPolicy

public void setMessageIDPolicy(JmsMessageIDPolicy messageIDPolicy)

isPopulateJMSXUserID

public boolean isPopulateJMSXUserID()

setPopulateJMSXUserID

public void setPopulateJMSXUserID(boolean populateMessageUserID)

getEncodedUsername

public byte[] getEncodedUsername()

getDeserializationPolicy

public JmsDeserializationPolicy getDeserializationPolicy()

setDeserializationPolicy

public void setDeserializationPolicy(JmsDeserializationPolicy deserializationPolicy)

isUseDaemonThread

public boolean isUseDaemonThread()

setUseDaemonThread

public void setUseDaemonThread(boolean useDaemonThread)

isAwaitClientID

public boolean isAwaitClientID()

setAwaitClientID

public void setAwaitClientID(boolean awaitClientID)

isCloseLinksThatFailOnReconnect

public boolean isCloseLinksThatFailOnReconnect()

setCloseLinksThatFailOnReconnect

public void setCloseLinksThatFailOnReconnect(boolean closeLinksThatFailOnReconnect)

getExtensionMap

public EnumMap<JmsConnectionExtensions,BiFunction<javax.jms.Connection,URI,Object>> getExtensionMap()

getConnection

public JmsConnection getConnection()

setConnection

public void setConnection(JmsConnection connection)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(JmsConnectionInfo other)

Specified by:

compareTo in interface Comparable<JmsConnectionInfo>

visit

public void visit(JmsResourceVistor vistor)
           throws Exception

Description copied from interface: JmsResource

Allows a visitor object to walk the resources and process them.

Specified by:

visit in interface JmsResource

Parameters:

vistor - The visitor instance that is processing this resource.

Throws:

Exception - if an error occurs while visiting this resource.

setTracer

public void setTracer(JmsTracer tracer)

getTracer

public JmsTracer getTracer()