org.hornetq.api.core.client
Interface ServerLocator

public interface ServerLocator

The serverLocator locates a server, but beyond that it locates a server based on a list.

If you are using straight TCP on the configuration, and if you configure your serverLocator to be HA, the locator will always get an updated list of members to the server, the server will send the updated list to the client.

If you use UDP or JGroups (exclusively JGropus or UDP), the initial discovery is done by the grouping finder, after the initial connection is made the server will always send updates to the client. But the listeners will listen for updates on grouping.

Author:

Tim Fox

Method Summary

void	addClusterTopologyListener(ClusterTopologyListener listener)
void	addIncomingInterceptor(Interceptor interceptor) Adds an interceptor which will be executed after packets are received from the server.
void	addInterceptor(Interceptor interceptor) Deprecated. As of HornetQ 2.3.0.Final, replaced by addIncomingInterceptor(Interceptor) and addOutgoingInterceptor(Interceptor)
void	addOutgoingInterceptor(Interceptor interceptor) Adds an interceptor which will be executed before packets are sent to the server.
void	close() Closes this factory and release all its resources
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, boolean failoverOnInitialConnection) Creates a ClientSessionFactory to a specific server.
void	disableFinalizeCheck() This method will disable any checks when a GarbageCollection happens leaving connections open.
int	getAckBatchSize() Returns the acknowledgments batch size.
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	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	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.
DiscoveryGroupConfiguration	getDiscoveryGroupConfiguration() The discovery group configuration
String	getGroupID() Returns the group ID that will be eventually set on each message for the property Message.HDR_GROUP_ID.
int	getInitialConnectAttempts()
int	getInitialMessagePacketSize() Returns the initial size of messages created through this factory.
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.
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.
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 live servers used when creating this object
int	getThreadPoolMaxSize() Returns the maximum size of the thread pool.
org.hornetq.core.client.impl.Topology	getTopology() Exposes the Topology used by this ServerLocator.
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 close was already called
boolean	isCompressLargeMessage() Whether to compress large messages.
boolean	isFailoverOnInitialConnection() Returns true if the client will automatically attempt to connect to the backup server if the initial connection to the live server fails Default value is HornetQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION.
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	isUseGlobalPools() Returns whether this factory will use global thread pools (shared among all the factories in the same JVM) or its own pools.
void	removeClusterTopologyListener(ClusterTopologyListener listener)
boolean	removeIncomingInterceptor(Interceptor interceptor) Removes an incoming interceptor.
boolean	removeInterceptor(Interceptor interceptor) Deprecated. As of HornetQ 2.3.0.Final, replaced by removeIncomingInterceptor(Interceptor) and removeOutgoingInterceptor(Interceptor)
boolean	removeOutgoingInterceptor(Interceptor interceptor) Removes an outgoing interceptor.
void	setAckBatchSize(int ackBatchSize) Sets the acknowledgments batch size.
void	setAutoGroup(boolean autoGroup) Sets whether producers created through this factory will automatically assign a group ID to the messages they sent.
void	setBlockOnAcknowledge(boolean blockOnAcknowledge) Sets whether consumers created through this factory will block while sending message acknowledgments or do it asynchronously.
void	setBlockOnDurableSend(boolean blockOnDurableSend) Sets whether producers created through this factory will block while sending durable messages or do it asynchronously.
void	setBlockOnNonDurableSend(boolean blockOnNonDurableSend) Sets whether producers created through this factory will block while sending non-durable messages or do it asynchronously.
void	setCacheLargeMessagesClient(boolean cached) Sets whether large messages received by consumers created through this factory will be cached in temporary files or not.
void	setCallFailoverTimeout(long callFailoverTimeout) Sets the blocking call failover timeout.
void	setCallTimeout(long callTimeout) Sets the blocking call timeout.
void	setClientFailureCheckPeriod(long clientFailureCheckPeriod) Sets the period (in milliseconds) used to check if a client has failed to receive pings from the server.
void	setCompressLargeMessage(boolean compressLargeMessages) Sets whether to compress or not large messages.
void	setConfirmationWindowSize(int confirmationWindowSize) Sets the size for the confirmation window buffer of clients using this factory.
void	setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName) Sets the class name of the connection load balancing policy.
void	setConnectionTTL(long connectionTTL) Sets this factory's connections time-to-live.
void	setConsumerMaxRate(int consumerMaxRate) Sets the maximum rate of message consumption for consumers created through this factory.
void	setConsumerWindowSize(int consumerWindowSize) Sets the window size for flow control of the consumers created through this factory.
void	setFailoverOnInitialConnection(boolean failover) Sets the value for FailoverOnInitialReconnection
void	setGroupID(String groupID) Sets the group ID that will be set on each message sent through this factory.
void	setInitialConnectAttempts(int reconnectAttempts) Sets the maximum number of attempts to establish an initial connection.
void	setInitialMessagePacketSize(int size) Sets the initial size of messages created through this factory.
void	setMaxRetryInterval(long maxRetryInterval) Sets the maximum retry interval.
void	setMinLargeMessageSize(int minLargeMessageSize) Sets the large message size threshold.
void	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.
void	setProducerMaxRate(int producerMaxRate) Sets the maximum rate of message production for producers created through this factory.
void	setProducerWindowSize(int producerWindowSize) Returns the window size for flow control of the producers created through this factory.
void	setReconnectAttempts(int reconnectAttempts) Sets the maximum number of attempts to retry connection in case of failure.
void	setRetryInterval(long retryInterval) Sets the time to retry connections created by this factory after failure.
void	setRetryIntervalMultiplier(double retryIntervalMultiplier) Sets the multiplier to apply to successive retry intervals.
void	setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize) Sets the maximum size of the scheduled thread pool.
void	setThreadPoolMaxSize(int threadPoolMaxSize) Sets the maximum size of the thread pool.
void	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.

Method Detail

isClosed

boolean isClosed()

Returns true if close was already called

Returns:

true if closed, false otherwise.

disableFinalizeCheck

void disableFinalizeCheck()

This method will disable any checks when a GarbageCollection happens leaving connections open. The JMS Layer will make specific usage of this method, since the ConnectionFactory.finalize should release this. Warning: You may leave resources unattended if you call this method and don't take care of cleaning the resources yourself.

createSessionFactory

ClientSessionFactory createSessionFactory()
                                          throws Exception

Creates a ClientSessionFactory using whatever load balancing policy is in force

Returns:

The ClientSessionFactory

Throws:

Exception

createSessionFactory

ClientSessionFactory createSessionFactory(String nodeID)
                                          throws Exception

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

Parameters:

nodeID -

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

ClientSessionFactory createSessionFactory(TransportConfiguration transportConfiguration)
                                          throws Exception

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

Parameters:

transportConfiguration -

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

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

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

Parameters:

transportConfiguration -

reconnectAttempts - number of attempts of reconnection to perform

failoverOnInitialConnection -

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

getClientFailureCheckPeriod

long getClientFailureCheckPeriod()

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

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

Returns:

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

setClientFailureCheckPeriod

void setClientFailureCheckPeriod(long clientFailureCheckPeriod)

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.

Parameters:

clientFailureCheckPeriod - the period to check failure

isCacheLargeMessagesClient

boolean isCacheLargeMessagesClient()

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 HornetQClient.DEFAULT_CACHE_LARGE_MESSAGE_CLIENT.

Returns:

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

setCacheLargeMessagesClient

void setCacheLargeMessagesClient(boolean cached)

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

Parameters:

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

getConnectionTTL

long getConnectionTTL()

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 HornetQClient.DEFAULT_CONNECTION_TTL.

Returns:

the connection time-to-live in milliseconds

setConnectionTTL

void setConnectionTTL(long connectionTTL)

Sets this factory's connections time-to-live. Value must be -1 (to disable) or greater or equals to 0.

Parameters:

connectionTTL - period in milliseconds

getCallTimeout

long getCallTimeout()

Returns the blocking calls timeout.

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

Returns:

the blocking calls timeout

setCallTimeout

void setCallTimeout(long callTimeout)

Sets the blocking call timeout.

Value must be greater or equals to 0

Parameters:

callTimeout - blocking call timeout in milliseconds

getCallFailoverTimeout

long getCallFailoverTimeout()

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.

Returns:

the blocking calls failover timeout

setCallFailoverTimeout

void setCallFailoverTimeout(long callFailoverTimeout)

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

Parameters:

callFailoverTimeout - blocking call timeout in milliseconds

getMinLargeMessageSize

int getMinLargeMessageSize()

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 HornetQClient.DEFAULT_MIN_LARGE_MESSAGE_SIZE.

Returns:

the message size threshold to treat messages as large messages.

setMinLargeMessageSize

void setMinLargeMessageSize(int minLargeMessageSize)

Sets the large message size threshold. Value must be greater than 0.

Parameters:

minLargeMessageSize - large message size threshold in bytes

getConsumerWindowSize

int getConsumerWindowSize()

Returns the window size for flow control of the consumers created through this factory. Value is in bytes, default value is HornetQClient.DEFAULT_CONSUMER_WINDOW_SIZE.

Returns:

the window size used for consumer flow control

setConsumerWindowSize

void setConsumerWindowSize(int consumerWindowSize)

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)

Parameters:

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

getConsumerMaxRate

int getConsumerMaxRate()

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 HornetQClient.DEFAULT_CONSUMER_MAX_RATE.

Returns:

the consumer max rate

setConsumerMaxRate

void setConsumerMaxRate(int consumerMaxRate)

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.

Parameters:

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

getConfirmationWindowSize

int getConfirmationWindowSize()

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 HornetQClient.DEFAULT_CONFIRMATION_WINDOW_SIZE.

Returns:

the size for the confirmation window of clients using this factory

setConfirmationWindowSize

void setConfirmationWindowSize(int confirmationWindowSize)

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.

Parameters:

confirmationWindowSize - size of the confirmation window (in bytes)

getProducerWindowSize

int getProducerWindowSize()

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 HornetQClient.DEFAULT_PRODUCER_WINDOW_SIZE.

Returns:

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

setProducerWindowSize

void setProducerWindowSize(int producerWindowSize)

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.

Parameters:

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

getProducerMaxRate

int getProducerMaxRate()

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 HornetQClient.DEFAULT_PRODUCER_MAX_RATE.

Returns:

maximum rate of message production (in messages per seconds)

setProducerMaxRate

void setProducerMaxRate(int producerMaxRate)

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.

Parameters:

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

isBlockOnAcknowledge

boolean isBlockOnAcknowledge()

Returns whether consumers created through this factory will block while sending message acknowledgments or do it asynchronously. Default value is HornetQClient.DEFAULT_BLOCK_ON_ACKNOWLEDGE.

Returns:

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

setBlockOnAcknowledge

void setBlockOnAcknowledge(boolean blockOnAcknowledge)

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

Parameters:

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

isBlockOnDurableSend

boolean isBlockOnDurableSend()

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 HornetQClient.DEFAULT_BLOCK_ON_DURABLE_SEND.

Returns:

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

setBlockOnDurableSend

void setBlockOnDurableSend(boolean blockOnDurableSend)

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

Parameters:

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

isBlockOnNonDurableSend

boolean isBlockOnNonDurableSend()

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 HornetQClient.DEFAULT_BLOCK_ON_NON_DURABLE_SEND.

Returns:

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

setBlockOnNonDurableSend

void setBlockOnNonDurableSend(boolean blockOnNonDurableSend)

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

Parameters:

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

isAutoGroup

boolean isAutoGroup()

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 HornetQClient.DEFAULT_AUTO_GROUP.

Returns:

whether producers will automatically assign a group ID to their messages

setAutoGroup

void setAutoGroup(boolean autoGroup)

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

Parameters:

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

getGroupID

String getGroupID()

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.

Returns:

the group ID that will be eventually set on each message

setGroupID

void setGroupID(String groupID)

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

Parameters:

groupID - the group ID to use

isPreAcknowledge

boolean isPreAcknowledge()

Returns whether messages will pre-acknowledged on the server before they are sent to the consumers or not. Default value is HornetQClient.DEFAULT_PRE_ACKNOWLEDGE

setPreAcknowledge

void 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.

Parameters:

preAcknowledge - true to enable pre-acknowledgment, false else

getAckBatchSize

int getAckBatchSize()

Returns the acknowledgments batch size. Default value is HornetQClient.DEFAULT_ACK_BATCH_SIZE.

Returns:

the acknowledgments batch size

setAckBatchSize

void setAckBatchSize(int ackBatchSize)

Sets the acknowledgments batch size. Value must be equal or greater than 0.

Parameters:

ackBatchSize - acknowledgments batch size

getStaticTransportConfigurations

TransportConfiguration[] getStaticTransportConfigurations()

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

Returns:

array with all static TransportConfigurations

getDiscoveryGroupConfiguration

DiscoveryGroupConfiguration getDiscoveryGroupConfiguration()

The discovery group configuration

isUseGlobalPools

boolean isUseGlobalPools()

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 HornetQClient.DEFAULT_USE_GLOBAL_POOLS.

Returns:

true if this factory uses global thread pools, false else

setUseGlobalPools

void 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.

Parameters:

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

getScheduledThreadPoolMaxSize

int getScheduledThreadPoolMaxSize()

Returns the maximum size of the scheduled thread pool. Default value is HornetQClient.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE.

Returns:

the maximum size of the scheduled thread pool.

setScheduledThreadPoolMaxSize

void setScheduledThreadPoolMaxSize(int scheduledThreadPoolMaxSize)

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.

Parameters:

scheduledThreadPoolMaxSize - maximum size of the scheduled thread pool.

getThreadPoolMaxSize

int getThreadPoolMaxSize()

Returns the maximum size of the thread pool. Default value is HornetQClient.DEFAULT_THREAD_POOL_MAX_SIZE.

Returns:

the maximum size of the thread pool.

setThreadPoolMaxSize

void setThreadPoolMaxSize(int threadPoolMaxSize)

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.

Parameters:

threadPoolMaxSize - maximum size of the thread pool.

getRetryInterval

long getRetryInterval()

Returns the time to retry connections created by this factory after failure. Value is in milliseconds, default is HornetQClient.DEFAULT_RETRY_INTERVAL.

Returns:

the time to retry connections created by this factory after failure

setRetryInterval

void setRetryInterval(long retryInterval)

Sets the time to retry connections created by this factory after failure. Value must be greater than 0.

Parameters:

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

getRetryIntervalMultiplier

double getRetryIntervalMultiplier()

Returns the multiplier to apply to successive retry intervals. Default value is HornetQClient.DEFAULT_RETRY_INTERVAL_MULTIPLIER.

Returns:

the multiplier to apply to successive retry intervals

setRetryIntervalMultiplier

void setRetryIntervalMultiplier(double retryIntervalMultiplier)

Sets the multiplier to apply to successive retry intervals. Value must be positive.

Parameters:

retryIntervalMultiplier - multiplier to apply to successive retry intervals

getMaxRetryInterval

long getMaxRetryInterval()

Returns the maximum retry interval (in the case a retry interval multiplier has been specified). Value is in milliseconds, default value is HornetQClient.DEFAULT_MAX_RETRY_INTERVAL.

Returns:

the maximum retry interval

setMaxRetryInterval

void setMaxRetryInterval(long maxRetryInterval)

Sets the maximum retry interval.

Value must be greater than 0.

Parameters:

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

getReconnectAttempts

int getReconnectAttempts()

Returns the maximum number of attempts to retry connection in case of failure. Default value is HornetQClient.DEFAULT_RECONNECT_ATTEMPTS.

Returns:

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

setReconnectAttempts

void setReconnectAttempts(int reconnectAttempts)

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.

Parameters:

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

setInitialConnectAttempts

void setInitialConnectAttempts(int reconnectAttempts)

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.

Parameters:

reconnectAttempts - maximum number of attempts for the initial connection

getInitialConnectAttempts

int getInitialConnectAttempts()

Returns:

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

isFailoverOnInitialConnection

boolean isFailoverOnInitialConnection()

Returns true if the client will automatically attempt to connect to the backup server if the initial connection to the live server fails Default value is HornetQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION.

setFailoverOnInitialConnection

void setFailoverOnInitialConnection(boolean failover)

Sets the value for FailoverOnInitialReconnection

Parameters:

failover -

getConnectionLoadBalancingPolicyClassName

String getConnectionLoadBalancingPolicyClassName()

Returns the class name of the connection load balancing policy. Default value is "org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy".

Returns:

the class name of the connection load balancing policy

setConnectionLoadBalancingPolicyClassName

void setConnectionLoadBalancingPolicyClassName(String loadBalancingPolicyClassName)

Sets the class name of the connection load balancing policy. Value must be the name of a class implementing ConnectionLoadBalancingPolicy.

Parameters:

loadBalancingPolicyClassName - class name of the connection load balancing policy

getInitialMessagePacketSize

int getInitialMessagePacketSize()

Returns the initial size of messages created through this factory. Value is in bytes, default value is HornetQClient.DEFAULT_INITIAL_MESSAGE_PACKET_SIZE.

Returns:

the initial size of messages created through this factory

setInitialMessagePacketSize

void setInitialMessagePacketSize(int size)

Sets the initial size of messages created through this factory. Value must be greater than 0.

Parameters:

size - initial size of messages created through this factory.

addInterceptor

@Deprecated
void addInterceptor(Interceptor interceptor)

Deprecated. As of HornetQ 2.3.0.Final, replaced by addIncomingInterceptor(Interceptor) and addOutgoingInterceptor(Interceptor)

Adds an interceptor which will be executed after packets are received from the server. Invoking this method is the same as invoking addIncomingInterceptor(Interceptor).

Parameters:

interceptor - an Interceptor

addIncomingInterceptor

void addIncomingInterceptor(Interceptor interceptor)

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

Parameters:

interceptor - an Interceptor

addOutgoingInterceptor

void addOutgoingInterceptor(Interceptor interceptor)

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

Parameters:

interceptor - an Interceptor

removeInterceptor

@Deprecated
boolean removeInterceptor(Interceptor interceptor)

Deprecated. As of HornetQ 2.3.0.Final, replaced by removeIncomingInterceptor(Interceptor) and removeOutgoingInterceptor(Interceptor)

Removes an interceptor. Invoking this method is the same as invoking removeIncomingInterceptor(Interceptor).

Parameters:

interceptor - interceptor to remove

Returns:

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

removeIncomingInterceptor

boolean removeIncomingInterceptor(Interceptor interceptor)

Removes an incoming interceptor.

Parameters:

interceptor - interceptor to remove

Returns:

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

removeOutgoingInterceptor

boolean removeOutgoingInterceptor(Interceptor interceptor)

Removes an outgoing interceptor.

Parameters:

interceptor - interceptor to remove

Returns:

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

close

void close()

Closes this factory and release all its resources

getTopology

org.hornetq.core.client.impl.Topology getTopology()

Exposes the Topology used by this ServerLocator.

Returns:

topology

isHA

boolean isHA()

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

Returns:

true if the locator receives topology updates from the cluster

isCompressLargeMessage

boolean isCompressLargeMessage()

Whether to compress large messages.

Returns:

setCompressLargeMessage

void setCompressLargeMessage(boolean compressLargeMessages)

Sets whether to compress or not large messages.

Parameters:

compressLargeMessages -

addClusterTopologyListener

void addClusterTopologyListener(ClusterTopologyListener listener)

removeClusterTopologyListener

void removeClusterTopologyListener(ClusterTopologyListener listener)