ServerLocatorImpl (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.hornetq.core.client.impl.ServerLocatorImpl

All Implemented Interfaces:

Serializable, ServerLocator, ServerLocatorInternal, DiscoveryListener
```
public class ServerLocatorImpl
extends Object
implements ServerLocatorInternal, DiscoveryListener, Serializable
```
A ServerLocatorImpl

Author:

Tim Fox

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Runnable finalizeCallback

Fields
Modifier and Type	Field and Description
`static Runnable`	`finalizeCallback`

Constructor Summary

Constructors
Constructor and 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 live 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 live servers

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClusterTopologyListener(ClusterTopologyListener listener)`
`void`	`addInterceptor(Interceptor interceptor)` Adds an interceptor which will be executed after packets are received from the server.
`void`	`cleanup()`
`static void`	`clearThreadPools()`
`void`	`close()` Closes this factory and release all its resources
`ClientSessionFactoryInternal`	`connect()`
`void`	`connectorsChanged()`
`ClientSessionFactory`	`createSessionFactory()` Create a ClientSessionFactory using whatever load balancing policy is in force
`ClientSessionFactory`	`createSessionFactory(String nodeID)` Create a ClientSessionFactory to a specific server.
`ClientSessionFactory`	`createSessionFactory(TransportConfiguration transportConfiguration)` Create a ClientSessionFactory to a specific server.
`void`	`disableFinalizeCheck()` This method will disable any checks when a GarbageCollection happens leaving connections open.
`protected void`	`doClose(boolean sendClose)`
`void`	`factoryClosed(ClientSessionFactory factory)`
`protected void`	`finalize()`
`int`	`getAckBatchSize()` Returns the acknowledgments batch size.
`AfterConnectInternalListener`	`getAfterConnectInternalListener()`
`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.
`TransportConfiguration`	`getClusterTransportConfiguration()`
`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
`Executor`	`getExecutor()`
`static ScheduledExecutorService`	`getGlobalScheduledThreadPool()`
`String`	`getGroupID()` Returns the group ID that will be eventually set on each message for the property `Message.HDR_GROUP_ID`.
`String`	`getIdentity()`
`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.
`String`	`getNodeID()`
`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.
`Topology`	`getTopology()`
`boolean`	`isAutoGroup()` Returns whether producers created through this factory will automatically assign a group ID to the messages they sent.
`boolean`	`isBackup()`
`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`	`isClusterConnection()`
`boolean`	`isCompressLargeMessage()`
`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()`
`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`	`notifyNodeDown(long eventTime, String nodeID)` 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, Pair<TransportConfiguration,TransportConfiguration> connectorPair, boolean last)`
`void`	`removeClusterTopologyListener(ClusterTopologyListener listener)`
`boolean`	`removeInterceptor(Interceptor interceptor)` Removes an interceptor.
`void`	`setAckBatchSize(int ackBatchSize)` Sets the acknowledgments batch size.
`void`	`setAfterConnectionInternalListener(AfterConnectInternalListener listener)`
`void`	`setAutoGroup(boolean autoGroup)` Sets whether producers created through this factory will automatically assign a group ID to the messages they sent.
`void`	`setBackup(boolean backup)`
`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`	`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`	`setClusterConnection(boolean clusterConnection)`
`void`	`setClusterTransportConfiguration(TransportConfiguration tc)`
`void`	`setCompressLargeMessage(boolean compress)`
`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`	`setIdentity(String identity)` Used to better identify Cluster Connection Locators on logs.
`void`	`setInitialConnectAttempts(int initialConnectAttempts)`
`void`	`setInitialMessagePacketSize(int size)` Sets the initial size of messages created through this factory.
`void`	`setMaxRetryInterval(long retryInterval)` Sets the maximum retry interval.
`void`	`setMinLargeMessageSize(int minLargeMessageSize)` Sets the large message size threshold.
`void`	`setNodeID(String nodeID)`
`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.
`void`	`start(Executor executor)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - finalizeCallback
```
public static Runnable finalizeCallback
```
- Constructor Detail
  - ServerLocatorImpl
```
public ServerLocatorImpl(boolean useHA,
                 DiscoveryGroupConfiguration groupConfiguration)
```
    Create a ServerLocatorImpl using UDP discovery to lookup cluster
    
    Parameters:
    discoveryAddress -
    discoveryPort -
  - ServerLocatorImpl
```
public ServerLocatorImpl(boolean useHA,
                 TransportConfiguration... transportConfigs)
```
    Create a ServerLocatorImpl using a static list of live servers
    
    Parameters:
    transportConfigs -
  - ServerLocatorImpl
```
public ServerLocatorImpl(Topology topology,
                 boolean useHA,
                 DiscoveryGroupConfiguration groupConfiguration)
```
    Create a ServerLocatorImpl using UDP discovery to lookup cluster
    
    Parameters:
    discoveryAddress -
    discoveryPort -
  - ServerLocatorImpl
```
public ServerLocatorImpl(Topology topology,
                 boolean useHA,
                 TransportConfiguration... transportConfigs)
```
    Create a ServerLocatorImpl using a static list of live servers
    
    Parameters:
    transportConfigs -
- Method Detail
  - clearThreadPools
```
public static void clearThreadPools()
```
  - getGlobalScheduledThreadPool
```
public static ScheduledExecutorService getGlobalScheduledThreadPool()
```
  - start
```
public void start(Executor executor)
           throws Exception
```
    Specified by:
    
    start in interface ServerLocatorInternal
    
    Throws:
    
    Exception
  - getExecutor
```
public Executor getExecutor()
```
    Specified by:
    
    getExecutor in interface ServerLocatorInternal
  - disableFinalizeCheck
```
public void disableFinalizeCheck()
```
    Description copied from interface: ServerLocator
    
    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.
    
    Specified by:
    
    disableFinalizeCheck in interface ServerLocator
  - connect
```
public ClientSessionFactoryInternal connect()
                                     throws Exception
```
    Specified by:
    
    connect in interface ServerLocatorInternal
    
    Throws:
    
    Exception
  - setAfterConnectionInternalListener
```
public void setAfterConnectionInternalListener(AfterConnectInternalListener listener)
```
    Specified by:
    
    setAfterConnectionInternalListener in interface ServerLocatorInternal
  - getAfterConnectInternalListener
```
public AfterConnectInternalListener getAfterConnectInternalListener()
```
    Specified by:
    
    getAfterConnectInternalListener in interface ServerLocatorInternal
  - createSessionFactory
```
public ClientSessionFactory createSessionFactory(String nodeID)
                                          throws Exception
```
    Description copied from interface: ServerLocator
    
    Create 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:
    The ClientSesionFactory 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
    
    Create 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:
    The ClientSesionFactory
    
    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 Exception
```
    Description copied from interface: ServerLocator
    
    Create a ClientSessionFactory using whatever load balancing policy is in force
    
    Specified by:
    
    createSessionFactory in interface ServerLocator
    
    Returns:
    The ClientSessionFactory
    
    Throws:
    
    Exception
  - isHA
```
public boolean isHA()
```
    Specified by:
    
    isHA 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 HornetQClient.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 void 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
  - 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 HornetQClient.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 void 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
  - 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 HornetQClient.DEFAULT_CONNECTION_TTL.
    
    Specified by:
    
    getConnectionTTL in interface ServerLocator
    
    Returns:
    the connection time-to-live in milliseconds
  - setConnectionTTL
```
public void 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
  - 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 HornetQException with the code HornetQException.CONNECTION_TIMEDOUT. Value is in milliseconds, default value is HornetQClient.DEFAULT_CALL_TIMEOUT.
    
    Specified by:
    
    getCallTimeout in interface ServerLocator
    
    Returns:
    the blocking calls timeout
  - setCallTimeout
```
public void 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
  - 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 HornetQClient.DEFAULT_MIN_LARGE_MESSAGE_SIZE.
    
    Specified by:
    
    getMinLargeMessageSize in interface ServerLocator
    
    Returns:
    the message size threshold to treat messages as large messages.
  - setMinLargeMessageSize
```
public void 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
  - 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 HornetQClient.DEFAULT_CONSUMER_WINDOW_SIZE.
    
    Specified by:
    
    getConsumerWindowSize in interface ServerLocator
    
    Returns:
    the window size used for consumer flow control
  - setConsumerWindowSize
```
public void 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
  - 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 HornetQClient.DEFAULT_CONSUMER_MAX_RATE.
    
    Specified by:
    
    getConsumerMaxRate in interface ServerLocator
    
    Returns:
    the consumer max rate
  - setConsumerMaxRate
```
public void 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)
  - 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 HornetQClient.DEFAULT_CONFIRMATION_WINDOW_SIZE.
    
    Specified by:
    
    getConfirmationWindowSize in interface ServerLocator
    
    Returns:
    the size for the confirmation window of clients using this factory
  - setConfirmationWindowSize
```
public void 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)
  - 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 HornetQClient.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 void 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.
  - 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 HornetQClient.DEFAULT_PRODUCER_MAX_RATE.
    
    Specified by:
    
    getProducerMaxRate in interface ServerLocator
    
    Returns:
    maximum rate of message production (in messages per seconds)
  - setProducerMaxRate
```
public void 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)
  - 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 HornetQClient.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 void 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
  - 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 HornetQClient.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 void 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
  - 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 HornetQClient.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 void 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
  - 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 HornetQClient.DEFAULT_AUTO_GROUP.
    
    Specified by:
    
    isAutoGroup in interface ServerLocator
    
    Returns:
    whether producers will automatically assign a group ID to their messages
  - setAutoGroup
```
public void 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
  - 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 HornetQClient.DEFAULT_PRE_ACKNOWLEDGE
    
    Specified by:
    
    isPreAcknowledge in interface ServerLocator
  - setPreAcknowledge
```
public void 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
  - getAckBatchSize
```
public int getAckBatchSize()
```
    Description copied from interface: ServerLocator
    
    Returns the acknowledgments batch size. Default value is HornetQClient.DEFAULT_ACK_BATCH_SIZE.
    
    Specified by:
    
    getAckBatchSize in interface ServerLocator
    
    Returns:
    the acknowledgments batch size
  - setAckBatchSize
```
public void 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
  - 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 HornetQClient.DEFAULT_USE_GLOBAL_POOLS.
    
    Specified by:
    
    isUseGlobalPools in interface ServerLocator
    
    Returns:
    true if this factory uses global thread pools, false else
  - setUseGlobalPools
```
public void 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
  - getScheduledThreadPoolMaxSize
```
public int getScheduledThreadPoolMaxSize()
```
    Description copied from interface: ServerLocator
    
    Returns the maximum size of the scheduled thread pool. Default value is HornetQClient.DEFAULT_SCHEDULED_THREAD_POOL_MAX_SIZE.
    
    Specified by:
    
    getScheduledThreadPoolMaxSize in interface ServerLocator
    
    Returns:
    the maximum size of the scheduled thread pool.
  - setScheduledThreadPoolMaxSize
```
public void 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.
  - getThreadPoolMaxSize
```
public int getThreadPoolMaxSize()
```
    Description copied from interface: ServerLocator
    
    Returns the maximum size of the thread pool. Default value is HornetQClient.DEFAULT_THREAD_POOL_MAX_SIZE.
    
    Specified by:
    
    getThreadPoolMaxSize in interface ServerLocator
    
    Returns:
    the maximum size of the thread pool.
  - setThreadPoolMaxSize
```
public void 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.
  - 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 HornetQClient.DEFAULT_RETRY_INTERVAL.
    
    Specified by:
    
    getRetryInterval in interface ServerLocator
    
    Returns:
    the time to retry connections created by this factory after failure
  - setRetryInterval
```
public void 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
  - 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 HornetQClient.DEFAULT_MAX_RETRY_INTERVAL.
    
    Specified by:
    
    getMaxRetryInterval in interface ServerLocator
    
    Returns:
    the maximum retry interval
  - setMaxRetryInterval
```
public void 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
  - getRetryIntervalMultiplier
```
public double getRetryIntervalMultiplier()
```
    Description copied from interface: ServerLocator
    
    Returns the multiplier to apply to successive retry intervals. Default value is HornetQClient.DEFAULT_RETRY_INTERVAL_MULTIPLIER.
    
    Specified by:
    
    getRetryIntervalMultiplier in interface ServerLocator
    
    Returns:
    the multiplier to apply to successive retry intervals
  - setRetryIntervalMultiplier
```
public void 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
  - 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 HornetQClient.DEFAULT_RECONNECT_ATTEMPTS.
    
    Specified by:
    
    getReconnectAttempts in interface ServerLocator
    
    Returns:
    the maximum number of attempts to retry connection in case of failure.
  - setReconnectAttempts
```
public void 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
  - setInitialConnectAttempts
```
public void setInitialConnectAttempts(int initialConnectAttempts)
```
    Specified by:
    
    setInitialConnectAttempts in interface ServerLocator
  - getInitialConnectAttempts
```
public int getInitialConnectAttempts()
```
    Specified by:
    
    getInitialConnectAttempts in interface ServerLocator
  - isFailoverOnInitialConnection
```
public boolean isFailoverOnInitialConnection()
```
    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 live server fails Default value is HornetQClient.DEFAULT_FAILOVER_ON_INITIAL_CONNECTION.
    
    Specified by:
    
    isFailoverOnInitialConnection in interface ServerLocator
  - setFailoverOnInitialConnection
```
public void setFailoverOnInitialConnection(boolean failover)
```
    Description copied from interface: ServerLocator
    
    Sets the value for FailoverOnInitialReconnection
    
    Specified by:
    
    setFailoverOnInitialConnection in interface ServerLocator
  - getConnectionLoadBalancingPolicyClassName
```
public String getConnectionLoadBalancingPolicyClassName()
```
    Description copied from interface: ServerLocator
    
    Returns the class name of the connection load balancing policy. Default value is "org.hornetq.api.core.client.loadbalance.RoundRobinConnectionLoadBalancingPolicy".
    
    Specified by:
    
    getConnectionLoadBalancingPolicyClassName in interface ServerLocator
    
    Returns:
    the class name of the connection load balancing policy
  - setConnectionLoadBalancingPolicyClassName
```
public void 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
  - getStaticTransportConfigurations
```
public TransportConfiguration[] getStaticTransportConfigurations()
```
    Description copied from interface: ServerLocator
    
    Returns an array of TransportConfigurations representing the static list of live servers used when creating this object
    
    Specified by:
    
    getStaticTransportConfigurations in interface ServerLocator
    
    Returns:
  - getDiscoveryGroupConfiguration
```
public DiscoveryGroupConfiguration getDiscoveryGroupConfiguration()
```
    Description copied from interface: ServerLocator
    
    The discovery group configuration
    
    Specified by:
    
    getDiscoveryGroupConfiguration in interface ServerLocator
  - addInterceptor
```
public void addInterceptor(Interceptor interceptor)
```
    Description copied from interface: ServerLocator
    
    Adds an interceptor which will be executed after packets are received from the server.
    
    Specified by:
    
    addInterceptor in interface ServerLocator
    
    Parameters:
    interceptor - an Interceptor
  - removeInterceptor
```
public boolean removeInterceptor(Interceptor interceptor)
```
    Description copied from interface: ServerLocator
    
    Removes an interceptor.
    
    Specified by:
    
    removeInterceptor in interface ServerLocator
    
    Parameters:
    interceptor - interceptor to remove
    
    Returns:
    true if the 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 HornetQClient.DEFAULT_INITIAL_MESSAGE_PACKET_SIZE.
    
    Specified by:
    
    getInitialMessagePacketSize in interface ServerLocator
    
    Returns:
    the initial size of messages created through this factory
  - setInitialMessagePacketSize
```
public void 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.
  - setGroupID
```
public void 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
  - 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()
```
    Specified by:
    
    isCompressLargeMessage in interface ServerLocator
  - setCompressLargeMessage
```
public void setCompressLargeMessage(boolean compress)
```
    Specified by:
    
    setCompressLargeMessage in interface ServerLocator
  - getIdentity
```
public String getIdentity()
```
    Specified by:
    
    getIdentity in interface ServerLocatorInternal
  - setIdentity
```
public void 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 void setNodeID(String nodeID)
```
    Specified by:
    
    setNodeID in interface ServerLocatorInternal
  - getNodeID
```
public String getNodeID()
```
    Specified by:
    
    getNodeID in interface ServerLocatorInternal
  - setClusterConnection
```
public void 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 void setClusterTransportConfiguration(TransportConfiguration tc)
```
    Specified by:
    
    setClusterTransportConfiguration in interface ServerLocatorInternal
  - isBackup
```
public boolean isBackup()
```
    Specified by:
    
    isBackup in interface ServerLocatorInternal
  - setBackup
```
public void setBackup(boolean backup)
```
    Specified by:
    
    setBackup in interface ServerLocatorInternal
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - 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 ServerLocator
  - doClose
```
protected void doClose(boolean sendClose)
```
  - notifyNodeDown
```
public void notifyNodeDown(long eventTime,
                  String nodeID)
```
    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
    
    Parameters:
    eventTime - 0 means get the previous ID +1
  - notifyNodeUp
```
public void notifyNodeUp(long uniqueEventID,
                String nodeID,
                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()
```
    Specified by:
    
    connectorsChanged in interface DiscoveryListener
  - factoryClosed
```
public void factoryClosed(ClientSessionFactory factory)
```
    Specified by:
    
    factoryClosed in interface ServerLocatorInternal
  - getTopology
```
public Topology getTopology()
```
    Specified by:
    
    getTopology in interface ServerLocatorInternal
  - addClusterTopologyListener
```
public void addClusterTopologyListener(ClusterTopologyListener listener)
```
    Specified by:
    
    addClusterTopologyListener in interface ServerLocator
  - removeClusterTopologyListener
```
public void removeClusterTopologyListener(ClusterTopologyListener listener)
```
    Specified by:
    
    removeClusterTopologyListener in interface ServerLocator
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: ServerLocator
    
    Returns true if close was already called
    
    Specified by:
    
    isClosed in interface ServerLocator
    
    Returns:

Class ServerLocatorImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

finalizeCallback

Constructor Detail

ServerLocatorImpl

ServerLocatorImpl

ServerLocatorImpl

ServerLocatorImpl

Method Detail

clearThreadPools

getGlobalScheduledThreadPool

start

getExecutor

disableFinalizeCheck

connect

setAfterConnectionInternalListener

getAfterConnectInternalListener

createSessionFactory

createSessionFactory

createSessionFactory

isHA

isCacheLargeMessagesClient

setCacheLargeMessagesClient

getClientFailureCheckPeriod

setClientFailureCheckPeriod

getConnectionTTL

setConnectionTTL

getCallTimeout

setCallTimeout

getMinLargeMessageSize

setMinLargeMessageSize

getConsumerWindowSize

setConsumerWindowSize

getConsumerMaxRate

setConsumerMaxRate

getConfirmationWindowSize

setConfirmationWindowSize

getProducerWindowSize

setProducerWindowSize

getProducerMaxRate

setProducerMaxRate

isBlockOnAcknowledge

setBlockOnAcknowledge

isBlockOnDurableSend

setBlockOnDurableSend

isBlockOnNonDurableSend

setBlockOnNonDurableSend

isAutoGroup

setAutoGroup

isPreAcknowledge

setPreAcknowledge

getAckBatchSize

setAckBatchSize

isUseGlobalPools

setUseGlobalPools

getScheduledThreadPoolMaxSize

setScheduledThreadPoolMaxSize

getThreadPoolMaxSize

setThreadPoolMaxSize

getRetryInterval

setRetryInterval

getMaxRetryInterval

setMaxRetryInterval

getRetryIntervalMultiplier

setRetryIntervalMultiplier

getReconnectAttempts

setReconnectAttempts

setInitialConnectAttempts

getInitialConnectAttempts

isFailoverOnInitialConnection

setFailoverOnInitialConnection

getConnectionLoadBalancingPolicyClassName

setConnectionLoadBalancingPolicyClassName

getStaticTransportConfigurations

getDiscoveryGroupConfiguration

addInterceptor