Package org.apache.activemq.artemis.core.client.impl

Class ServerLocatorImpl

java.lang.Object

org.apache.activemq.artemis.core.client.impl.ServerLocatorImpl

All Implemented Interfaces:

AutoCloseable, ServerLocator, ServerLocatorInternal, DiscoveryListener

public final class ServerLocatorImpl
extends Object
implements ServerLocatorInternal, DiscoveryListener

This is the implementation of ServerLocator and all the proper javadoc is located on that interface.

Constructor Summary

Constructors

Constructor	Description
ServerLocatorImpl(boolean useHA, DiscoveryGroupConfiguration groupConfiguration)	Create a ServerLocatorImpl using UDP discovery to lookup cluster
ServerLocatorImpl(boolean useHA, TransportConfiguration... transportConfigs)	Create a ServerLocatorImpl using a static list of servers
ServerLocatorImpl(Topology topology, boolean useHA, DiscoveryGroupConfiguration groupConfiguration)	Create a ServerLocatorImpl using UDP discovery to lookup cluster
ServerLocatorImpl(Topology topology, boolean useHA, TransportConfiguration... transportConfigs)	Create a ServerLocatorImpl using a static list of servers

Method Summary

Modifier and Type	Method	Description
ServerLocatorImpl	addClusterTopologyListener(ClusterTopologyListener listener)
ServerLocatorImpl	addIncomingInterceptor(Interceptor interceptor)	Adds an interceptor which will be executed after packets are received from the server.
ServerLocatorImpl	addOutgoingInterceptor(Interceptor interceptor)	Adds an interceptor which will be executed before packets are sent to the server.
boolean	allInVM()	Verify if all of the transports are using inVM.
void	cleanup()
static void	clearThreadPools()
void	close()	Closes this factory and release all its resources
ClientSessionFactoryInternal	connect()
ClientSessionFactoryInternal	connectNoWarnings()	Like ServerLocatorInternal.connect() but it does not log warnings if it fails to connect.
void	connectorsChanged(List<DiscoveryEntry> newConnectors)
ClientSessionFactory	createSessionFactory()	Creates a ClientSessionFactory using whatever load balancing policy is in force
ClientSessionFactory	createSessionFactory(String nodeID)	Creates a ClientSessionFactory to a specific server.
ClientSessionFactory	createSessionFactory(TransportConfiguration transportConfiguration)	Creates a ClientSessionFactory to a specific server.
ClientSessionFactory	createSessionFactory(TransportConfiguration transportConfiguration, int reconnectAttempts)	Creates a ClientSessionFactory to a specific server.
ClientSessionFactory	createSessionFactory(TransportConfiguration transportConfiguration, int reconnectAttempts, boolean failoverOnInitialConnection)	Deprecated.
void	factoryClosed(ClientSessionFactory factory)
void	flushTopology()
int	getAckBatchSize()	Returns the acknowledgments batch size.
AfterConnectInternalListener	getAfterConnectInternalListener()
long	getCallFailoverTimeout()	Returns the blocking calls failover timeout when the client is awaiting failover, this is over and above the normal call timeout.
long	getCallTimeout()	Returns the blocking calls timeout.
long	getClientFailureCheckPeriod()	Returns the period used to check if a client has failed to receive pings from the server.
int	getClientSessionFactoryCount()
TransportConfiguration	getClusterTransportConfiguration()
int	getCompressionLevel()	What compression level is in use
int	getConfirmationWindowSize()	Returns the size for the confirmation window of clients using this factory.
String	getConnectionLoadBalancingPolicyClassName()	Returns the class name of the connection load balancing policy.
long	getConnectionTTL()	Returns the connection time-to-live.
int	getConnectorsSize()
int	getConsumerMaxRate()	Returns the maximum rate of message consumption for consumers created through this factory.
int	getConsumerWindowSize()	Returns the window size for flow control of the consumers created through this factory.
DiscoveryGroup	getDiscoveryGroup()	For tests only
DiscoveryGroupConfiguration	getDiscoveryGroupConfiguration()	The discovery group configuration
Set<ClientSessionFactoryInternal>	getFactories()	For tests only
int	getFailoverAttempts()	Returns the number of failover attempts after a connection failure.
int	getFlowControlThreadPoolMaxSize()	Returns the maximum size of the flow-control thread pool.
String	getGroupID()	Returns the group ID that will be eventually set on each message for the property Message.HDR_GROUP_ID.
String	getIncomingInterceptorList()
int	getInitialConnectAttempts()	Returns the number of attempts to be made for first initial connection.
TransportConfiguration[]	getInitialConnectors()	for tests only and not part of the public interface.
int	getInitialMessagePacketSize()	Returns the initial size of messages created through this factory.
ServerLocatorConfig	getLocatorConfig()
long	getMaxRetryInterval()	Returns the maximum retry interval (in the case a retry interval multiplier has been specified).
int	getMinLargeMessageSize()	Returns the large message size threshold.
long	getNextRetryInterval(long retryInterval, double retryIntervalMultiplier, long maxRetryInterval)
String	getNodeID()
int	getOnMessageCloseTimeout()	Returns the timeout for onMessage completion when closing ClientConsumers created through this factory.
String	getOutgoingInterceptorList()
String	getPasswordCodec()
int	getProducerMaxRate()	Returns the maximum rate of message production for producers created through this factory.
int	getProducerWindowSize()	Returns the window size for flow control of the producers created through this factory.
ClientProtocolManagerFactory	getProtocolManagerFactory()
int	getReconnectAttempts()	Returns the maximum number of attempts to retry connection in case of failure.
long	getRetryInterval()	Returns the time to retry connections created by this factory after failure.
double	getRetryIntervalMultiplier()	Returns the multiplier to apply to successive retry intervals.
int	getScheduledThreadPoolMaxSize()	Returns the maximum size of the scheduled thread pool.
TransportConfiguration[]	getStaticTransportConfigurations()	Returns an array of TransportConfigurations representing the static list of servers used when creating this object
int	getThreadPoolMaxSize()	Returns the maximum size of the thread pool.
Topology	getTopology()	Exposes the Topology used by this ServerLocator.
boolean	getUseTopologyForLoadBalancing()
void	initialize()	This will only instantiate internal objects such as the topology
boolean	isAutoGroup()	Returns whether producers created through this factory will automatically assign a group ID to the messages they sent.
boolean	isBlockOnAcknowledge()	Returns whether consumers created through this factory will block while sending message acknowledgments or do it asynchronously.
boolean	isBlockOnDurableSend()	Returns whether producers created through this factory will block while sending durable messages or do it asynchronously.
boolean	isBlockOnNonDurableSend()	Returns whether producers created through this factory will block while sending non-durable messages or do it asynchronously.
boolean	isCacheLargeMessagesClient()	When true, consumers created through this factory will create temporary files to cache large messages.
boolean	isClosed()	Returns true if closed, false otherwise.
boolean	isClusterConnection()
boolean	isCompressLargeMessage()	Whether to compress large messages.
boolean	isConnectable()
boolean	isFailoverOnInitialConnection()	Deprecated.
boolean	isHA()	Whether this server receives topology notifications from the cluster as servers join or leave the cluster.
boolean	isPreAcknowledge()	Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not.
boolean	isReceivedTopology()
boolean	isUseGlobalPools()	Returns whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools.
static ServerLocator	newLocator(String uri)
static ServerLocator	newLocator(URI uri)
ClientProtocolManager	newProtocolManager()
void	notifyNodeDown(long eventTime, String nodeID, boolean disconnect)	This is directly called when the connection to the node is gone, or when the node sends a disconnection.
void	notifyNodeUp(long uniqueEventID, String nodeID, String backupGroupName, String scaleDownGroupName, Pair<TransportConfiguration,TransportConfiguration> connectorPair, boolean last)
void	removeClusterTopologyListener(ClusterTopologyListener listener)
boolean	removeIncomingInterceptor(Interceptor interceptor)	Removes an incoming interceptor.
boolean	removeOutgoingInterceptor(Interceptor interceptor)	Removes an outgoing interceptor.
void	resetToInitialConnectors()
Pair<TransportConfiguration,TransportConfiguration>	selectNextConnectorPair()
ServerLocatorImpl	setAckBatchSize(int ackBatchSize)	Sets the acknowledgments batch size.
ServerLocatorImpl	setAfterConnectionInternalListener(AfterConnectInternalListener listener)
ServerLocatorImpl	setAutoGroup(boolean autoGroup)	Sets whether producers created through this factory will automatically assign a group ID to the messages they sent.
ServerLocatorImpl	setBlockOnAcknowledge(boolean blockOnAcknowledge)	Sets whether consumers created through this factory will block while sending message acknowledgments or do it asynchronously.
ServerLocatorImpl	setBlockOnDurableSend(boolean blockOnDurableSend)	Sets whether producers created through this factory will block while sending durable messages or do it asynchronously.
ServerLocatorImpl	setBlockOnNonDurableSend(boolean blockOnNonDurableSend)	Sets whether producers created through this factory will block while sending non-durable messages or do it asynchronously.
ServerLocatorImpl	setCacheLargeMessagesClient(boolean cached)	Sets whether large messages received by consumers created through this factory will be cached in temporary files or not.
ServerLocatorImpl	setCallFailoverTimeout(long callFailoverTimeout)	Sets the blocking call failover timeout.
ServerLocatorImpl	setCallTimeout(long callTimeout)	Sets the blocking call timeout.
ServerLocatorImpl	setClientFailureCheckPeriod(long clientFailureCheckPeriod)	Sets the period (in milliseconds) used to check if a client has failed to receive pings from the server.
ServerLocatorImpl	setClusterConnection(boolean clusterConnection)
ServerLocatorImpl	setClusterTransportConfiguration(TransportConfiguration tc)
ServerLocatorImpl	setCompressionLevel(int compressionLevel)	Sets what compressionLevel to use when compressing messages Value must be -1 (default), or 0-9
ServerLocatorImpl	setCompressLargeMessage(boolean avoid)	Sets whether to compress or not large messages.
ServerLocatorImpl	setConfirmationWindowSize(int confirmationWindowSize)	Sets the size for the confirmation window buffer of clients using this factory.
ServerLocatorImpl	setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName)	Sets the class name of the connection load balancing policy.
ServerLocatorImpl	setConnectionTTL(long connectionTTL)	Sets this factory's connections time-to-live.
ServerLocatorImpl	setConsumerMaxRate(int consumerMaxRate)	Sets the maximum rate of message consumption for consumers created through this factory.
ServerLocatorImpl	setConsumerWindowSize(int consumerWindowSize)	Sets the window size for flow control of the consumers created through this factory.
ServerLocatorImpl	setDiscoveryListener(DiscoveryListener discoveryListener)
ServerLocatorImpl	setFailoverAttempts(int attempts)	Sets the maximum number of failover attempts to establish a connection to other primary servers after a connection failure.
ServerLocatorImpl	setFailoverOnInitialConnection(boolean failover)	Deprecated.
ServerLocatorImpl	setFlowControlThreadPoolMaxSize(int flowControlThreadPoolMaxSize)	Sets the maximum size of the flow-control thread pool.
ServerLocatorImpl	setGroupID(String groupID)	Sets the group ID that will be set on each message sent through this factory.
ServerLocatorImpl	setIdentity(String identity)	Used to better identify Cluster Connection Locators on logs.
ServerLocator	setIncomingInterceptorList(String interceptorList)	Set the list of Interceptors to use for incoming packets.
ServerLocatorImpl	setInitialConnectAttempts(int initialConnectAttempts)	Sets the maximum number of attempts to establish an initial connection.
ServerLocatorImpl	setInitialMessagePacketSize(int size)	Sets the initial size of messages created through this factory.
void	setLocatorConfig(ServerLocatorConfig config)
ServerLocatorImpl	setMaxRetryInterval(long retryInterval)	Sets the maximum retry interval.
ServerLocatorImpl	setMinLargeMessageSize(int minLargeMessageSize)	Sets the large message size threshold.
ServerLocatorImpl	setNodeID(String nodeID)
ServerLocator	setOnMessageCloseTimeout(int onMessageCloseTimeout)	Sets the timeout in milliseconds for onMessage completion when closing ClientConsumers created through this factory.
ServerLocator	setOutgoingInterceptorList(String interceptorList)	Set the list of Interceptors to use for outgoing packets.
ServerLocator	setPasswordCodec(String passwordCodec)
ServerLocatorImpl	setPreAcknowledge(boolean preAcknowledge)	Sets to true to pre-acknowledge consumed messages on the server before they are sent to consumers, else set to false to let clients acknowledge the message they consume.
ServerLocatorImpl	setProducerMaxRate(int producerMaxRate)	Sets the maximum rate of message production for producers created through this factory.
ServerLocatorImpl	setProducerWindowSize(int producerWindowSize)	Returns the window size for flow control of the producers created through this factory.
ServerLocator	setProtocolManagerFactory(ClientProtocolManagerFactory protocolManagerFactory)
ServerLocatorImpl	setReconnectAttempts(int reconnectAttempts)	Sets the maximum number of attempts to retry connection in case of failure.
ServerLocatorImpl	setRetryInterval(long retryInterval)	Sets the time to retry connections created by this factory after failure.
ServerLocatorImpl	setRetryIntervalMultiplier(double retryIntervalMultiplier)	Sets the multiplier to apply to successive retry intervals.
ServerLocatorImpl	setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)	Sets the maximum size of the scheduled thread pool.
ServerLocatorImpl	setThreadPoolMaxSize(int threadPoolMaxSize)	Sets the maximum size of the thread pool.
boolean	setThreadPools(Executor threadPool, ScheduledExecutorService scheduledThreadPool, Executor flowControlThreadPool)
ServerLocatorImpl	setUseGlobalPools(boolean useGlobalPools)	Sets whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools.
ServerLocator	setUseTopologyForLoadBalancing(boolean useTopologyForLoadBalancing)
void	start(Executor executor)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.api.core.client.ServerLocator

disableFinalizeCheck

Methods inherited from interface org.apache.activemq.artemis.core.client.impl.ServerLocatorInternal

notifyNodeDown

Constructor Details

ServerLocatorImpl

public ServerLocatorImpl(boolean useHA,
 DiscoveryGroupConfiguration groupConfiguration)

Create a ServerLocatorImpl using UDP discovery to lookup cluster

ServerLocatorImpl

public ServerLocatorImpl(boolean useHA,
 TransportConfiguration... transportConfigs)

Create a ServerLocatorImpl using a static list of servers

ServerLocatorImpl

public ServerLocatorImpl(Topology topology,
 boolean useHA,
 DiscoveryGroupConfiguration groupConfiguration)

Create a ServerLocatorImpl using UDP discovery to lookup cluster

ServerLocatorImpl

public ServerLocatorImpl(Topology topology,
 boolean useHA,
 TransportConfiguration... transportConfigs)

Create a ServerLocatorImpl using a static list of servers

Method Details

getDiscoveryGroup

public DiscoveryGroup getDiscoveryGroup()

For tests only

getFactories

public Set<ClientSessionFactoryInternal> getFactories()

For tests only

clearThreadPools

public static void clearThreadPools()

setThreadPools

public boolean setThreadPools(Executor threadPool,
 ScheduledExecutorService scheduledThreadPool,
 Executor flowControlThreadPool)

Specified by:

setThreadPools in interface ServerLocator

initialize

public void initialize()
                throws ActiveMQException

Description copied from interface: ServerLocator

This will only instantiate internal objects such as the topology

Specified by:

initialize in interface ServerLocator

Throws:

ActiveMQException

getLocatorConfig

public ServerLocatorConfig getLocatorConfig()

Specified by:

getLocatorConfig in interface ServerLocator

setLocatorConfig

public void setLocatorConfig(ServerLocatorConfig config)

Specified by:

setLocatorConfig in interface ServerLocator

setPasswordCodec

public ServerLocator setPasswordCodec(String passwordCodec)

Specified by:

setPasswordCodec in interface ServerLocator

getPasswordCodec

public String getPasswordCodec()

Specified by:

getPasswordCodec in interface ServerLocator

newLocator

public static ServerLocator newLocator(String uri)

newLocator

public static ServerLocator newLocator(URI uri)

resetToInitialConnectors

public void resetToInitialConnectors()

Specified by:

resetToInitialConnectors in interface ServerLocatorInternal

allInVM

public boolean allInVM()

Description copied from interface: ServerLocator

Verify if all of the transports are using inVM.

Specified by:

allInVM in interface ServerLocator

Returns:

true if the locator has all inVM transports

selectNextConnectorPair

public Pair<TransportConfiguration,TransportConfiguration> selectNextConnectorPair()

Specified by:

selectNextConnectorPair in interface ServerLocatorInternal

getConnectorsSize

public int getConnectorsSize()

Specified by:

getConnectorsSize in interface ServerLocatorInternal

start

public void start(Executor executor)
           throws Exception

Specified by:

start in interface ServerLocatorInternal

Throws:

Exception

newProtocolManager

public ClientProtocolManager newProtocolManager()

Specified by:

newProtocolManager in interface ServerLocatorInternal

getProtocolManagerFactory

public ClientProtocolManagerFactory getProtocolManagerFactory()

Specified by:

getProtocolManagerFactory in interface ServerLocator

setProtocolManagerFactory

public ServerLocator setProtocolManagerFactory(ClientProtocolManagerFactory protocolManagerFactory)

Specified by:

setProtocolManagerFactory in interface ServerLocator

connect

public ClientSessionFactoryInternal connect()
                                     throws ActiveMQException

Specified by:

connect in interface ServerLocatorInternal

Throws:

ActiveMQException

connectNoWarnings

public ClientSessionFactoryInternal connectNoWarnings()
                                               throws ActiveMQException

Description copied from interface: ServerLocatorInternal

Like ServerLocatorInternal.connect() but it does not log warnings if it fails to connect.

Specified by:

connectNoWarnings in interface ServerLocatorInternal

Throws:

ActiveMQException

setAfterConnectionInternalListener

public ServerLocatorImpl setAfterConnectionInternalListener(AfterConnectInternalListener listener)

Specified by:

setAfterConnectionInternalListener in interface ServerLocatorInternal

getAfterConnectInternalListener

public AfterConnectInternalListener getAfterConnectInternalListener()

Specified by:

getAfterConnectInternalListener in interface ServerLocatorInternal

setDiscoveryListener

public ServerLocatorImpl setDiscoveryListener(DiscoveryListener discoveryListener)

Specified by:

setDiscoveryListener in interface ServerLocatorInternal

createSessionFactory

public ClientSessionFactory createSessionFactory(String nodeID)
                                          throws Exception

Description copied from interface: ServerLocator

Creates a ClientSessionFactory to a specific server. The server must already be known about by this ServerLocator. This method allows the user to make a connection to a specific server bypassing any load balancing policy in force

Specified by:

createSessionFactory in interface ServerLocator

Returns:

a ClientSessionFactory instance or null if the node is not present on the topology

Throws:

Exception - if a failure happened in creating the ClientSessionFactory or the ServerLocator does not know about the passed in transportConfiguration

createSessionFactory

public ClientSessionFactory createSessionFactory(TransportConfiguration transportConfiguration)
                                          throws Exception

Description copied from interface: ServerLocator

Creates a ClientSessionFactory to a specific server. The server must already be known about by this ServerLocator. This method allows the user to make a connection to a specific server bypassing any load balancing policy in force

Specified by:

createSessionFactory in interface ServerLocator

Returns:

a ClientSessionFactory instance

Throws:

Exception - if a failure happened in creating the ClientSessionFactory or the ServerLocator does not know about the passed in transportConfiguration

createSessionFactory

public ClientSessionFactory createSessionFactory(TransportConfiguration transportConfiguration,
 int reconnectAttempts)
                                          throws Exception

Description copied from interface: ServerLocator

Creates a ClientSessionFactory to a specific server. The server must already be known about by this ServerLocator. This method allows the user to make a connection to a specific server bypassing any load balancing policy in force

Specified by:

createSessionFactory in interface ServerLocator

reconnectAttempts - number of attempts of reconnection to perform

Returns:

a ClientSessionFactory instance

Throws:

Exception - if a failure happened in creating the ClientSessionFactory or the ServerLocator does not know about the passed in transportConfiguration

createSessionFactory

@Deprecated
public ClientSessionFactory createSessionFactory(TransportConfiguration transportConfiguration,
 int reconnectAttempts,
 boolean failoverOnInitialConnection)
                                          throws Exception

Deprecated.

Description copied from interface: ServerLocator

Creates a ClientSessionFactory to a specific server. The server must already be known about by this ServerLocator. This method allows the user to make a connection to a specific server bypassing any load balancing policy in force

Specified by:

createSessionFactory in interface ServerLocator

reconnectAttempts - number of attempts of reconnection to perform

Returns:

a ClientSessionFactory instance

Throws:

Exception - if a failure happened in creating the ClientSessionFactory or the ServerLocator does not know about the passed in transportConfiguration

createSessionFactory

public ClientSessionFactory createSessionFactory()
                                          throws ActiveMQException

Description copied from interface: ServerLocator

Creates a ClientSessionFactory using whatever load balancing policy is in force

Specified by:

createSessionFactory in interface ServerLocator

Returns:

The ClientSessionFactory

Throws:

ActiveMQException

getNextRetryInterval

public long getNextRetryInterval(long retryInterval,
 double retryIntervalMultiplier,
 long maxRetryInterval)

Specified by:

getNextRetryInterval in interface ServerLocatorInternal

flushTopology

public void flushTopology()

isHA

public boolean isHA()

Description copied from interface: ServerLocator

Whether this server receives topology notifications from the cluster as servers join or leave the cluster.

Specified by:

isHA in interface ServerLocator

Returns:

true if the locator receives topology updates from the cluster

setIncomingInterceptorList

public ServerLocator setIncomingInterceptorList(String interceptorList)

Description copied from interface: ServerLocator

Set the list of Interceptors to use for incoming packets.

Specified by:

setIncomingInterceptorList in interface ServerLocator

Parameters:

interceptorList - a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method.

Returns:

this

getIncomingInterceptorList

public String getIncomingInterceptorList()

Specified by:

getIncomingInterceptorList in interface ServerLocator

setOutgoingInterceptorList

public ServerLocator setOutgoingInterceptorList(String interceptorList)

Description copied from interface: ServerLocator

Set the list of Interceptors to use for outgoing packets.

Specified by:

setOutgoingInterceptorList in interface ServerLocator

Parameters:

interceptorList - a comma separated string of incoming interceptor class names to be used. Each interceptor needs a default Constructor to be used with this method.

Returns:

this

getOutgoingInterceptorList

public String getOutgoingInterceptorList()

Specified by:

getOutgoingInterceptorList in interface ServerLocator

isCacheLargeMessagesClient

public boolean isCacheLargeMessagesClient()

Description copied from interface: ServerLocator

When true, consumers created through this factory will create temporary files to cache large messages.

There is 1 temporary file created for each large message.

Default value is ActiveMQClient.DEFAULT_CACHE_LARGE_MESSAGE_CLIENT.

Specified by:

isCacheLargeMessagesClient in interface ServerLocator

Returns:

true if consumers created through this factory will cache large messages in temporary files, false else

setCacheLargeMessagesClient

public ServerLocatorImpl setCacheLargeMessagesClient(boolean cached)

Description copied from interface: ServerLocator

Sets whether large messages received by consumers created through this factory will be cached in temporary files or not.

Specified by:

setCacheLargeMessagesClient in interface ServerLocator

Parameters:

cached - true to cache large messages in temporary files, false else

Returns:

this ServerLocator

getClientFailureCheckPeriod

public long getClientFailureCheckPeriod()

Description copied from interface: ServerLocator

Returns the period used to check if a client has failed to receive pings from the server.

Period is in milliseconds, default value is ActiveMQClient.DEFAULT_CLIENT_FAILURE_CHECK_PERIOD.

Specified by:

getClientFailureCheckPeriod in interface ServerLocator

Returns:

the period used to check if a client has failed to receive pings from the server

setClientFailureCheckPeriod

public ServerLocatorImpl setClientFailureCheckPeriod(long clientFailureCheckPeriod)

Description copied from interface: ServerLocator

Sets the period (in milliseconds) used to check if a client has failed to receive pings from the server.

Value must be -1 (to disable) or greater than 0.

Specified by:

setClientFailureCheckPeriod in interface ServerLocator

Parameters:

clientFailureCheckPeriod - the period to check failure

Returns:

this ServerLocator

getConnectionTTL

public long getConnectionTTL()

Description copied from interface: ServerLocator

Returns the connection time-to-live.

This TTL determines how long the server will keep a connection alive in the absence of any data arriving from the client. Value is in milliseconds, default value is ActiveMQClient.DEFAULT_CONNECTION_TTL.

Specified by:

getConnectionTTL in interface ServerLocator

Returns:

the connection time-to-live in milliseconds

setConnectionTTL

public ServerLocatorImpl setConnectionTTL(long connectionTTL)

Description copied from interface: ServerLocator

Sets this factory's connections time-to-live.

Value must be -1 (to disable) or greater or equals to 0.

Specified by:

setConnectionTTL in interface ServerLocator

Parameters:

connectionTTL - period in milliseconds

Returns:

this ServerLocator

getCallTimeout

public long getCallTimeout()

Description copied from interface: ServerLocator

Returns the blocking calls timeout.

If client's blocking calls to the server take more than this timeout, the call will throw a ActiveMQException with the code ActiveMQExceptionType.CONNECTION_TIMEDOUT. Value is in milliseconds, default value is ActiveMQClient.DEFAULT_CALL_TIMEOUT.

Specified by:

getCallTimeout in interface ServerLocator

Returns:

the blocking calls timeout

setCallTimeout

public ServerLocatorImpl setCallTimeout(long callTimeout)

Description copied from interface: ServerLocator

Sets the blocking call timeout.

Value must be greater or equals to 0

Specified by:

setCallTimeout in interface ServerLocator

Parameters:

callTimeout - blocking call timeout in milliseconds

Returns:

this ServerLocator

getCallFailoverTimeout

public long getCallFailoverTimeout()

Description copied from interface: ServerLocator

Returns the blocking calls failover timeout when the client is awaiting failover, this is over and above the normal call timeout.

If client is in the process of failing over when a blocking call is called then the client will wait this long before actually trying the send.

Specified by:

getCallFailoverTimeout in interface ServerLocator

Returns:

the blocking calls failover timeout

setCallFailoverTimeout

public ServerLocatorImpl setCallFailoverTimeout(long callFailoverTimeout)

Description copied from interface: ServerLocator

Sets the blocking call failover timeout.

When the client is awaiting failover, this is over and above the normal call timeout.

Value must be greater or equals to -1, -1 means forever

Specified by:

setCallFailoverTimeout in interface ServerLocator

Parameters:

callFailoverTimeout - blocking call timeout in milliseconds

Returns:

this ServerLocator

getMinLargeMessageSize

public int getMinLargeMessageSize()

Description copied from interface: ServerLocator

Returns the large message size threshold.

Messages whose size is if greater than this value will be handled as large messages. Value is in bytes, default value is ActiveMQClient.DEFAULT_MIN_LARGE_MESSAGE_SIZE.

Specified by:

getMinLargeMessageSize in interface ServerLocator

Returns:

the message size threshold to treat messages as large messages

setMinLargeMessageSize

public ServerLocatorImpl setMinLargeMessageSize(int minLargeMessageSize)

Description copied from interface: ServerLocator

Sets the large message size threshold.

Value must be greater than 0.

Specified by:

setMinLargeMessageSize in interface ServerLocator

Parameters:

minLargeMessageSize - large message size threshold in bytes

Returns:

this ServerLocator

getConsumerWindowSize

public int getConsumerWindowSize()

Description copied from interface: ServerLocator

Returns the window size for flow control of the consumers created through this factory.

Value is in bytes, default value is ActiveMQClient.DEFAULT_CONSUMER_WINDOW_SIZE.

Specified by:

getConsumerWindowSize in interface ServerLocator

Returns:

the window size used for consumer flow control

setConsumerWindowSize

public ServerLocatorImpl setConsumerWindowSize(int consumerWindowSize)

Description copied from interface: ServerLocator

Sets the window size for flow control of the consumers created through this factory.

Value must be -1 (to disable flow control), 0 (to not buffer any messages) or greater than 0 (to set the maximum size of the buffer)

Specified by:

setConsumerWindowSize in interface ServerLocator

Parameters:

consumerWindowSize - window size (in bytes) used for consumer flow control

Returns:

this ServerLocator

getConsumerMaxRate

public int getConsumerMaxRate()

Description copied from interface: ServerLocator

Returns the maximum rate of message consumption for consumers created through this factory.

This value controls the rate at which a consumer can consume messages. A consumer will never consume messages at a rate faster than the rate specified.

Value is -1 (to disable) or a positive integer corresponding to the maximum desired message consumption rate specified in units of messages per second. Default value is ActiveMQClient.DEFAULT_CONSUMER_MAX_RATE.

Specified by:

getConsumerMaxRate in interface ServerLocator

Returns:

the consumer max rate

setConsumerMaxRate

public ServerLocatorImpl setConsumerMaxRate(int consumerMaxRate)

Description copied from interface: ServerLocator

Sets the maximum rate of message consumption for consumers created through this factory.

Value must -1 (to disable) or a positive integer corresponding to the maximum desired message consumption rate specified in units of messages per second.

Specified by:

setConsumerMaxRate in interface ServerLocator

Parameters:

consumerMaxRate - maximum rate of message consumption (in messages per seconds)

Returns:

this ServerLocator

getConfirmationWindowSize

public int getConfirmationWindowSize()

Description copied from interface: ServerLocator

Returns the size for the confirmation window of clients using this factory.

Value is in bytes or -1 (to disable the window). Default value is ActiveMQClient.DEFAULT_CONFIRMATION_WINDOW_SIZE.

Specified by:

getConfirmationWindowSize in interface ServerLocator

Returns:

the size for the confirmation window of clients using this factory

setConfirmationWindowSize

public ServerLocatorImpl setConfirmationWindowSize(int confirmationWindowSize)

Description copied from interface: ServerLocator

Sets the size for the confirmation window buffer of clients using this factory.

Value must be -1 (to disable the window) or greater than 0.

Specified by:

setConfirmationWindowSize in interface ServerLocator

Parameters:

confirmationWindowSize - size of the confirmation window (in bytes)

Returns:

this ServerLocator

getProducerWindowSize

public int getProducerWindowSize()

Description copied from interface: ServerLocator

Returns the window size for flow control of the producers created through this factory.

Value must be -1 (to disable flow control) or greater than 0 to determine the maximum amount of bytes at any give time (to prevent overloading the connection). Default value is ActiveMQClient.DEFAULT_PRODUCER_WINDOW_SIZE.

Specified by:

getProducerWindowSize in interface ServerLocator

Returns:

the window size for flow control of the producers created through this factory

setProducerWindowSize

public ServerLocatorImpl setProducerWindowSize(int producerWindowSize)

Description copied from interface: ServerLocator

Returns the window size for flow control of the producers created through this factory.

Value must be -1 (to disable flow control) or greater than 0.

Specified by:

setProducerWindowSize in interface ServerLocator

Parameters:

producerWindowSize - window size (in bytest) for flow control of the producers created through this factory.

Returns:

this ServerLocator

getProducerMaxRate

public int getProducerMaxRate()

Description copied from interface: ServerLocator

Returns the maximum rate of message production for producers created through this factory.

This value controls the rate at which a producer can produce messages. A producer will never produce messages at a rate faster than the rate specified.

Value is -1 (to disable) or a positive integer corresponding to the maximum desired message production rate specified in units of messages per second. Default value is ActiveMQClient.DEFAULT_PRODUCER_MAX_RATE.

Specified by:

getProducerMaxRate in interface ServerLocator

Returns:

maximum rate of message production (in messages per seconds)

setProducerMaxRate

public ServerLocatorImpl setProducerMaxRate(int producerMaxRate)

Description copied from interface: ServerLocator

Sets the maximum rate of message production for producers created through this factory.

Value must -1 (to disable) or a positive integer corresponding to the maximum desired message production rate specified in units of messages per second.

Specified by:

setProducerMaxRate in interface ServerLocator

Parameters:

producerMaxRate - maximum rate of message production (in messages per seconds)

Returns:

this ServerLocator

isBlockOnAcknowledge

public boolean isBlockOnAcknowledge()

Description copied from interface: ServerLocator

Returns whether consumers created through this factory will block while sending message acknowledgments or do it asynchronously.

Default value is ActiveMQClient.DEFAULT_BLOCK_ON_ACKNOWLEDGE.

Specified by:

isBlockOnAcknowledge in interface ServerLocator

Returns:

whether consumers will block while sending message acknowledgments or do it asynchronously

setBlockOnAcknowledge

public ServerLocatorImpl setBlockOnAcknowledge(boolean blockOnAcknowledge)

Description copied from interface: ServerLocator

Sets whether consumers created through this factory will block while sending message acknowledgments or do it asynchronously.

Specified by:

setBlockOnAcknowledge in interface ServerLocator

Parameters:

blockOnAcknowledge - true to block when sending message acknowledgments or false to send them asynchronously

Returns:

this ServerLocator

isBlockOnDurableSend

public boolean isBlockOnDurableSend()

Description copied from interface: ServerLocator

Returns whether producers created through this factory will block while sending durable messages or do it asynchronously.

If the session is configured to send durable message asynchronously, the client can set a SendAcknowledgementHandler on the ClientSession to be notified once the message has been handled by the server.

Default value is ActiveMQClient.DEFAULT_BLOCK_ON_DURABLE_SEND.

Specified by:

isBlockOnDurableSend in interface ServerLocator

Returns:

whether producers will block while sending persistent messages or do it asynchronously

setBlockOnDurableSend

public ServerLocatorImpl setBlockOnDurableSend(boolean blockOnDurableSend)

Description copied from interface: ServerLocator

Sets whether producers created through this factory will block while sending durable messages or do it asynchronously.

Specified by:

setBlockOnDurableSend in interface ServerLocator

Parameters:

blockOnDurableSend - true to block when sending durable messages or false to send them asynchronously

Returns:

this ServerLocator

isBlockOnNonDurableSend

public boolean isBlockOnNonDurableSend()

Description copied from interface: ServerLocator

Returns whether producers created through this factory will block while sending non-durable messages or do it asynchronously.

If the session is configured to send non-durable message asynchronously, the client can set a SendAcknowledgementHandler on the ClientSession to be notified once the message has been handled by the server.

Default value is ActiveMQClient.DEFAULT_BLOCK_ON_NON_DURABLE_SEND.

Specified by:

isBlockOnNonDurableSend in interface ServerLocator

Returns:

whether producers will block while sending non-durable messages or do it asynchronously

setBlockOnNonDurableSend

public ServerLocatorImpl setBlockOnNonDurableSend(boolean blockOnNonDurableSend)

Description copied from interface: ServerLocator

Sets whether producers created through this factory will block while sending non-durable messages or do it asynchronously.

Specified by:

setBlockOnNonDurableSend in interface ServerLocator

Parameters:

blockOnNonDurableSend - true to block when sending non-durable messages or false to send them asynchronously

Returns:

this ServerLocator

isAutoGroup

public boolean isAutoGroup()

Description copied from interface: ServerLocator

Returns whether producers created through this factory will automatically assign a group ID to the messages they sent.

if true, a random unique group ID is created and set on each message for the property Message.HDR_GROUP_ID. Default value is ActiveMQClient.DEFAULT_AUTO_GROUP.

Specified by:

isAutoGroup in interface ServerLocator

Returns:

whether producers will automatically assign a group ID to their messages

setAutoGroup

public ServerLocatorImpl setAutoGroup(boolean autoGroup)

Description copied from interface: ServerLocator

Sets whether producers created through this factory will automatically assign a group ID to the messages they sent.

Specified by:

setAutoGroup in interface ServerLocator

Parameters:

autoGroup - true to automatically assign a group ID to each messages sent through this factory, false else

Returns:

this ServerLocator

isPreAcknowledge

public boolean isPreAcknowledge()

Description copied from interface: ServerLocator

Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not.

Default value is ActiveMQClient.DEFAULT_PRE_ACKNOWLEDGE

Specified by:

isPreAcknowledge in interface ServerLocator

setPreAcknowledge

public ServerLocatorImpl setPreAcknowledge(boolean preAcknowledge)

Description copied from interface: ServerLocator

Sets to true to pre-acknowledge consumed messages on the server before they are sent to consumers, else set to false to let clients acknowledge the message they consume.

Specified by:

setPreAcknowledge in interface ServerLocator

Parameters:

preAcknowledge - true to enable pre-acknowledgment, false else

Returns:

this ServerLocator

getAckBatchSize

public int getAckBatchSize()

Description copied from interface: ServerLocator

Returns the acknowledgments batch size.

Default value is ActiveMQClient.DEFAULT_ACK_BATCH_SIZE.

Specified by:

getAckBatchSize in interface ServerLocator

Returns:

the acknowledgments batch size

setAckBatchSize

public ServerLocatorImpl setAckBatchSize(int ackBatchSize)

Description copied from interface: ServerLocator

Sets the acknowledgments batch size.

Value must be equal or greater than 0.

Specified by:

setAckBatchSize in interface ServerLocator

Parameters:

ackBatchSize - acknowledgments batch size

Returns:

this ServerLocator

isUseGlobalPools

public boolean isUseGlobalPools()

Description copied from interface: ServerLocator

Returns whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools.

Default value is ActiveMQClient.DEFAULT_USE_GLOBAL_POOLS.

Specified by:

isUseGlobalPools in interface ServerLocator

Returns:

true if this factory uses global thread pools, false else

setUseGlobalPools

public ServerLocatorImpl setUseGlobalPools(boolean useGlobalPools)

Description copied from interface: ServerLocator

Sets whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools.

Specified by:

setUseGlobalPools in interface ServerLocator

Parameters:

useGlobalPools - true to let this factory uses global thread pools, false else

Returns:

this ServerLocator

getScheduledThreadPoolMaxSize

public int getScheduledThreadPoolMaxSize()

Description copied from interface: ServerLocator

Returns the maximum size of the scheduled thread pool.

Default value is ActiveMQClient.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE.

Specified by:

getScheduledThreadPoolMaxSize in interface ServerLocator

Returns:

the maximum size of the scheduled thread pool

setScheduledThreadPoolMaxSize

public ServerLocatorImpl setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)

Description copied from interface: ServerLocator

Sets the maximum size of the scheduled thread pool.

This setting is relevant only if this factory does not use global pools. Value must be greater than 0.

Specified by:

setScheduledThreadPoolMaxSize in interface ServerLocator

Parameters:

scheduledThreadPoolMaxSize - maximum size of the scheduled thread pool.

Returns:

this ServerLocator

getThreadPoolMaxSize

public int getThreadPoolMaxSize()

Description copied from interface: ServerLocator

Returns the maximum size of the thread pool.

Default value is ActiveMQClient.DEFAULT_THREAD_POOL_MAX_SIZE.

Specified by:

getThreadPoolMaxSize in interface ServerLocator

Returns:

the maximum size of the thread pool

setThreadPoolMaxSize

public ServerLocatorImpl setThreadPoolMaxSize(int threadPoolMaxSize)

Description copied from interface: ServerLocator

Sets the maximum size of the thread pool.

This setting is relevant only if this factory does not use global pools. Value must be -1 (for unlimited thread pool) or greater than 0.

Specified by:

setThreadPoolMaxSize in interface ServerLocator

Parameters:

threadPoolMaxSize - maximum size of the thread pool.

Returns:

this ServerLocator

getFlowControlThreadPoolMaxSize

public int getFlowControlThreadPoolMaxSize()

Description copied from interface: ServerLocator

Returns the maximum size of the flow-control thread pool.

Default value is ActiveMQClient.DEFAULT_FLOW_CONTROL_THREAD_POOL_MAX_SIZE.

Specified by:

getFlowControlThreadPoolMaxSize in interface ServerLocator

Returns:

the maximum size of the flow-control thread pool

setFlowControlThreadPoolMaxSize

public ServerLocatorImpl setFlowControlThreadPoolMaxSize(int flowControlThreadPoolMaxSize)

Description copied from interface: ServerLocator

Sets the maximum size of the flow-control thread pool.

This setting is relevant only if this factory does not use global pools. Value must be -1 (for unlimited thread pool) or greater than 0.

Specified by:

setFlowControlThreadPoolMaxSize in interface ServerLocator

Parameters:

flowControlThreadPoolMaxSize - maximum size of the flow-control thread pool.

Returns:

this ServerLocator

getRetryInterval

public long getRetryInterval()

Description copied from interface: ServerLocator

Returns the time to retry connections created by this factory after failure.

Value is in milliseconds, default is ActiveMQClient.DEFAULT_RETRY_INTERVAL.

Specified by:

getRetryInterval in interface ServerLocator

Returns:

the time to retry connections created by this factory after failure

setRetryInterval

public ServerLocatorImpl setRetryInterval(long retryInterval)

Description copied from interface: ServerLocator

Sets the time to retry connections created by this factory after failure.

Value must be greater than 0.

Specified by:

setRetryInterval in interface ServerLocator

Parameters:

retryInterval - time (in milliseconds) to retry connections created by this factory after failure

Returns:

this ServerLocator

getMaxRetryInterval

public long getMaxRetryInterval()

Description copied from interface: ServerLocator

Returns the maximum retry interval (in the case a retry interval multiplier has been specified).

Value is in milliseconds, default value is ActiveMQClient.DEFAULT_MAX_RETRY_INTERVAL.

Specified by:

getMaxRetryInterval in interface ServerLocator

Returns:

the maximum retry interval

setMaxRetryInterval

public ServerLocatorImpl setMaxRetryInterval(long retryInterval)

Description copied from interface: ServerLocator

Sets the maximum retry interval.

Value must be greater than 0.

Specified by:

setMaxRetryInterval in interface ServerLocator

Parameters:

retryInterval - maximum retry interval to apply in the case a retry interval multiplier has been specified

Returns:

this ServerLocator

getRetryIntervalMultiplier

public double getRetryIntervalMultiplier()

Description copied from interface: ServerLocator

Returns the multiplier to apply to successive retry intervals.

Default value is ActiveMQClient.DEFAULT_RETRY_INTERVAL_MULTIPLIER.

Specified by:

getRetryIntervalMultiplier in interface ServerLocator

Returns:

the multiplier to apply to successive retry intervals

setRetryIntervalMultiplier

public ServerLocatorImpl setRetryIntervalMultiplier(double retryIntervalMultiplier)

Description copied from interface: ServerLocator

Sets the multiplier to apply to successive retry intervals.

Value must be positive.

Specified by:

setRetryIntervalMultiplier in interface ServerLocator

Parameters:

retryIntervalMultiplier - multiplier to apply to successive retry intervals

Returns:

this ServerLocator

getReconnectAttempts

public int getReconnectAttempts()

Description copied from interface: ServerLocator

Returns the maximum number of attempts to retry connection in case of failure.

Default value is ActiveMQClient.DEFAULT_RECONNECT_ATTEMPTS.

Specified by:

getReconnectAttempts in interface ServerLocator

Returns:

the maximum number of attempts to retry connection in case of failure

setReconnectAttempts

public ServerLocatorImpl setReconnectAttempts(int reconnectAttempts)

Description copied from interface: ServerLocator

Sets the maximum number of attempts to retry connection in case of failure.

Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0.

Specified by:

setReconnectAttempts in interface ServerLocator

Parameters:

reconnectAttempts - maximum number of attempts to retry connection in case of failure

Returns:

this ServerLocator

setInitialConnectAttempts

public ServerLocatorImpl setInitialConnectAttempts(int initialConnectAttempts)

Description copied from interface: ServerLocator

Sets the maximum number of attempts to establish an initial connection.

Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0.

Specified by:

setInitialConnectAttempts in interface ServerLocator

Parameters:

initialConnectAttempts - maximum number of attempts for the initial connection

Returns:

this ServerLocator

getInitialConnectAttempts

public int getInitialConnectAttempts()

Description copied from interface: ServerLocator

Returns the number of attempts to be made for first initial connection.

Specified by:

getInitialConnectAttempts in interface ServerLocator

Returns:

the number of attempts to be made for first initial connection

setFailoverAttempts

public ServerLocatorImpl setFailoverAttempts(int attempts)

Description copied from interface: ServerLocator

Sets the maximum number of failover attempts to establish a connection to other primary servers after a connection failure.

Value must be -1 (to retry infinitely), 0 (to never retry connection) or greater than 0.

Specified by:

setFailoverAttempts in interface ServerLocator

Parameters:

attempts - maximum number of failover attempts after a connection failure

Returns:

this ServerLocator

getFailoverAttempts

public int getFailoverAttempts()

Description copied from interface: ServerLocator

Returns the number of failover attempts after a connection failure.

Specified by:

getFailoverAttempts in interface ServerLocator

Returns:

the number of failover attempts after a connection failure

isFailoverOnInitialConnection

@Deprecated
public boolean isFailoverOnInitialConnection()

Deprecated.

Description copied from interface: ServerLocator

Returns true if the client will automatically attempt to connect to the backup server if the initial connection to the primary server fails

Default value is ActiveMQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION.

Specified by:

isFailoverOnInitialConnection in interface ServerLocator

setFailoverOnInitialConnection

@Deprecated
public ServerLocatorImpl setFailoverOnInitialConnection(boolean failover)

Deprecated.

Description copied from interface: ServerLocator

Sets the value for FailoverOnInitialReconnection

Specified by:

setFailoverOnInitialConnection in interface ServerLocator

Returns:

this ServerLocator

getConnectionLoadBalancingPolicyClassName

public String getConnectionLoadBalancingPolicyClassName()

Description copied from interface: ServerLocator

Returns the class name of the connection load balancing policy.

Default value is "org.apache.activemq.artemis.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy".

Specified by:

getConnectionLoadBalancingPolicyClassName in interface ServerLocator

Returns:

the class name of the connection load balancing policy

setConnectionLoadBalancingPolicyClassName

public ServerLocatorImpl setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName)

Description copied from interface: ServerLocator

Sets the class name of the connection load balancing policy.

Value must be the name of a class implementing ConnectionLoadBalancingPolicy.

Specified by:

setConnectionLoadBalancingPolicyClassName in interface ServerLocator

Parameters:

loadBalancingPolicyClassName - class name of the connection load balancing policy

Returns:

this ServerLocator

getStaticTransportConfigurations

public TransportConfiguration[] getStaticTransportConfigurations()

Description copied from interface: ServerLocator

Returns an array of TransportConfigurations representing the static list of servers used when creating this object

Specified by:

getStaticTransportConfigurations in interface ServerLocator

Returns:

array with all static TransportConfigurations

getDiscoveryGroupConfiguration

public DiscoveryGroupConfiguration getDiscoveryGroupConfiguration()

Description copied from interface: ServerLocator

The discovery group configuration

Specified by:

getDiscoveryGroupConfiguration in interface ServerLocator

addIncomingInterceptor

public ServerLocatorImpl addIncomingInterceptor(Interceptor interceptor)

Description copied from interface: ServerLocator

Adds an interceptor which will be executed after packets are received from the server.

Specified by:

addIncomingInterceptor in interface ServerLocator

Parameters:

interceptor - an Interceptor

Returns:

this ServerLocator

addOutgoingInterceptor

public ServerLocatorImpl addOutgoingInterceptor(Interceptor interceptor)

Description copied from interface: ServerLocator

Adds an interceptor which will be executed before packets are sent to the server.

Specified by:

addOutgoingInterceptor in interface ServerLocator

Parameters:

interceptor - an Interceptor

Returns:

this ServerLocator

removeIncomingInterceptor

public boolean removeIncomingInterceptor(Interceptor interceptor)

Description copied from interface: ServerLocator

Removes an incoming interceptor.

Specified by:

removeIncomingInterceptor in interface ServerLocator

Parameters:

interceptor - interceptor to remove

Returns:

true if the incoming interceptor is removed from this factory, false else

removeOutgoingInterceptor

public boolean removeOutgoingInterceptor(Interceptor interceptor)

Description copied from interface: ServerLocator

Removes an outgoing interceptor.

Specified by:

removeOutgoingInterceptor in interface ServerLocator

Parameters:

interceptor - interceptor to remove

Returns:

true if the outgoing interceptor is removed from this factory, false else

getInitialMessagePacketSize

public int getInitialMessagePacketSize()

Description copied from interface: ServerLocator

Returns the initial size of messages created through this factory.

Value is in bytes, default value is ActiveMQClient.DEFAULT_INITIAL_MESSAGE_PACKET_SIZE.

Specified by:

getInitialMessagePacketSize in interface ServerLocator

Returns:

the initial size of messages created through this factory

setInitialMessagePacketSize

public ServerLocatorImpl setInitialMessagePacketSize(int size)

Description copied from interface: ServerLocator

Sets the initial size of messages created through this factory.

Value must be greater than 0.

Specified by:

setInitialMessagePacketSize in interface ServerLocator

Parameters:

size - initial size of messages created through this factory.

Returns:

this ServerLocator

getOnMessageCloseTimeout

public int getOnMessageCloseTimeout()

Description copied from interface: ServerLocator

Returns the timeout for onMessage completion when closing ClientConsumers created through this factory.

Value is in milliseconds, default value is ActiveMQClient.DEFAULT_ONMESSAGE_CLOSE_TIMEOUT.

Specified by:

getOnMessageCloseTimeout in interface ServerLocator

Returns:

the timeout for onMessage completion when closing ClientConsumers created through this factory

setOnMessageCloseTimeout

public ServerLocator setOnMessageCloseTimeout(int onMessageCloseTimeout)

Description copied from interface: ServerLocator

Sets the timeout in milliseconds for onMessage completion when closing ClientConsumers created through this factory.

A value of -1 means wait until the onMessage completes no matter how long it takes.

Specified by:

setOnMessageCloseTimeout in interface ServerLocator

Parameters:

onMessageCloseTimeout - how long to wait in milliseconds for the ClientConsumer's MessageHandler's onMessage method to finish before closing or stopping the ClientConsumer.

Returns:

this ServerLocator

setGroupID

public ServerLocatorImpl setGroupID(String groupID)

Description copied from interface: ServerLocator

Sets the group ID that will be set on each message sent through this factory.

Specified by:

setGroupID in interface ServerLocator

Parameters:

groupID - the group ID to use

Returns:

this ServerLocator

getGroupID

public String getGroupID()

Description copied from interface: ServerLocator

Returns the group ID that will be eventually set on each message for the property Message.HDR_GROUP_ID.

Default value is is null and no group ID will be set on the messages.

Specified by:

getGroupID in interface ServerLocator

Returns:

the group ID that will be eventually set on each message

isCompressLargeMessage

public boolean isCompressLargeMessage()

Description copied from interface: ServerLocator

Whether to compress large messages.

Specified by:

isCompressLargeMessage in interface ServerLocator

setCompressLargeMessage

public ServerLocatorImpl setCompressLargeMessage(boolean avoid)

Description copied from interface: ServerLocator

Sets whether to compress or not large messages.

Specified by:

setCompressLargeMessage in interface ServerLocator

Returns:

this ServerLocator

getCompressionLevel

public int getCompressionLevel()

Description copied from interface: ServerLocator

What compression level is in use

Specified by:

getCompressionLevel in interface ServerLocator

setCompressionLevel

public ServerLocatorImpl setCompressionLevel(int compressionLevel)

Description copied from interface: ServerLocator

Sets what compressionLevel to use when compressing messages Value must be -1 (default), or 0-9

Specified by:

setCompressionLevel in interface ServerLocator

Returns:

this ServerLocator

setIdentity

public ServerLocatorImpl setIdentity(String identity)

Description copied from interface: ServerLocatorInternal

Used to better identify Cluster Connection Locators on logs. To facilitate eventual debugging.

This method used to be on tests interface, but I'm now making it part of the public interface since

Specified by:

setIdentity in interface ServerLocatorInternal

setNodeID

public ServerLocatorImpl setNodeID(String nodeID)

Specified by:

setNodeID in interface ServerLocatorInternal

getNodeID

public String getNodeID()

Specified by:

getNodeID in interface ServerLocatorInternal

setClusterConnection

public ServerLocatorImpl setClusterConnection(boolean clusterConnection)

Specified by:

setClusterConnection in interface ServerLocatorInternal

isClusterConnection

public boolean isClusterConnection()

Specified by:

isClusterConnection in interface ServerLocatorInternal

getClusterTransportConfiguration

public TransportConfiguration getClusterTransportConfiguration()

Specified by:

getClusterTransportConfiguration in interface ServerLocatorInternal

setClusterTransportConfiguration

public ServerLocatorImpl setClusterTransportConfiguration(TransportConfiguration tc)

Specified by:

setClusterTransportConfiguration in interface ServerLocatorInternal

cleanup

public void cleanup()

Specified by:

cleanup in interface ServerLocatorInternal

close

public void close()

Description copied from interface: ServerLocator

Closes this factory and release all its resources

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ServerLocator

notifyNodeDown

public void notifyNodeDown(long eventTime,
 String nodeID,
 boolean disconnect)

This is directly called when the connection to the node is gone, or when the node sends a disconnection. Look for callers of this method!

Specified by:

notifyNodeDown in interface ServerLocatorInternal

notifyNodeUp

public void notifyNodeUp(long uniqueEventID,
 String nodeID,
 String backupGroupName,
 String scaleDownGroupName,
 Pair<TransportConfiguration,TransportConfiguration> connectorPair,
 boolean last)

Specified by:

notifyNodeUp in interface ServerLocatorInternal

toString

public String toString()

Overrides:

toString in class Object

connectorsChanged

public void connectorsChanged(List<DiscoveryEntry> newConnectors)

Specified by:

connectorsChanged in interface DiscoveryListener

factoryClosed

public void factoryClosed(ClientSessionFactory factory)

Specified by:

factoryClosed in interface ServerLocatorInternal

setUseTopologyForLoadBalancing

public ServerLocator setUseTopologyForLoadBalancing(boolean useTopologyForLoadBalancing)

Specified by:

setUseTopologyForLoadBalancing in interface ServerLocator

getUseTopologyForLoadBalancing

public boolean getUseTopologyForLoadBalancing()

Specified by:

getUseTopologyForLoadBalancing in interface ServerLocator

getTopology

public Topology getTopology()

Description copied from interface: ServerLocator

Exposes the Topology used by this ServerLocator.

Specified by:

getTopology in interface ServerLocator

Specified by:

getTopology in interface ServerLocatorInternal

Returns:

topology

isConnectable

public boolean isConnectable()

Specified by:

isConnectable in interface ServerLocatorInternal

addClusterTopologyListener

public ServerLocatorImpl addClusterTopologyListener(ClusterTopologyListener listener)

Specified by:

addClusterTopologyListener in interface ServerLocator

removeClusterTopologyListener

public void removeClusterTopologyListener(ClusterTopologyListener listener)

Specified by:

removeClusterTopologyListener in interface ServerLocator

getInitialConnectors

public TransportConfiguration[] getInitialConnectors()

for tests only and not part of the public interface. Do not use it.

isClosed

public boolean isClosed()

Description copied from interface: ServerLocator

Returns true if closed, false otherwise.

Specified by:

isClosed in interface ServerLocator

Returns:

true if closed, false otherwise

isReceivedTopology

public boolean isReceivedTopology()

getClientSessionFactoryCount

public int getClientSessionFactoryCount()