Class LocalizedQueueConnectionFactory
- java.lang.Object
-
- org.springframework.amqp.rabbit.connection.LocalizedQueueConnectionFactory
-
- All Implemented Interfaces:
ConnectionFactory
,RoutingConnectionFactory
,DisposableBean
public class LocalizedQueueConnectionFactory extends Object implements ConnectionFactory, RoutingConnectionFactory, DisposableBean
ARoutingConnectionFactory
that determines the node on which a queue is located and returns a factory that connects directly to that node. The RabbitMQ management plugin is called over REST to determine the node and the corresponding address for that node is injected into the connection factory. A single instance of each connection factory is retained in a cache. If the location cannot be determined, the default connection factory is returned. This connection factory is typically configured to connect to all the servers in a fail-over mode.getTargetConnectionFactory(Object)
is invoked by theSimpleMessageListenerContainer
, when establishing a connection, with the lookup key having the format'[queueName]'
.All
ConnectionFactory
methods delegate to the default- Since:
- 1.2
- Author:
- Gary Russell
-
-
Constructor Summary
Constructors Constructor Description LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, String[] addresses, String[] adminUris, String[] nodes, String vhost, String username, String password, boolean useSSL, String keyStore, String trustStore, String keyStorePassPhrase, String trustStorePassPhrase)
LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, String[] addresses, String[] adminUris, String[] nodes, String vhost, String username, String password, boolean useSSL, Resource sslPropertiesLocation)
LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, Map<String,String> nodeToAddress, String[] adminUris, String vhost, String username, String password, boolean useSSL, String keyStore, String trustStore, String keyStorePassPhrase, String trustStorePassPhrase)
LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, Map<String,String> nodeToAddress, String[] adminUris, String vhost, String username, String password, boolean useSSL, Resource sslPropertiesLocation)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addConnectionListener(ConnectionListener listener)
void
clearConnectionListeners()
protected com.rabbitmq.http.client.Client
createClient(String adminUri, String username, String password)
Create a client instance.Connection
createConnection()
protected ConnectionFactory
createConnectionFactory(String address, String node)
Create a dedicated connection factory for the address.void
destroy()
String
getHost()
int
getPort()
ConnectionFactory
getTargetConnectionFactory(Object key)
Returns theConnectionFactory
bound to given lookup key, or null if one does not exist.String
getUsername()
String
getVirtualHost()
boolean
removeConnectionListener(ConnectionListener listener)
void
resetConnection()
Close any connection(s) that might be cached by this factory.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.springframework.amqp.rabbit.connection.ConnectionFactory
getPublisherConnectionFactory, isPublisherConfirms, isPublisherReturns, isSimplePublisherConfirms
-
-
-
-
Constructor Detail
-
LocalizedQueueConnectionFactory
public LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, Map<String,String> nodeToAddress, String[] adminUris, String vhost, String username, String password, boolean useSSL, Resource sslPropertiesLocation)
- Parameters:
defaultConnectionFactory
- the fallback connection factory to use if the queue can't be located.nodeToAddress
- a Map of node to address: (rabbit@server1 : server1:5672)adminUris
- the rabbitmq admin addresses (https://host:port, ...) must be the same length as addresses.vhost
- the virtual host.username
- the user name.password
- the password.useSSL
- use SSL.sslPropertiesLocation
- the SSL properties location.
-
LocalizedQueueConnectionFactory
public LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, Map<String,String> nodeToAddress, String[] adminUris, String vhost, String username, String password, boolean useSSL, String keyStore, String trustStore, String keyStorePassPhrase, String trustStorePassPhrase)
- Parameters:
defaultConnectionFactory
- the fallback connection factory to use if the queue can't be located.nodeToAddress
- a Map of node to address: (rabbit@server1 : server1:5672)adminUris
- the rabbitmq admin addresses (https://host:port, ...) must be the same length as addresses.vhost
- the virtual host.username
- the user name.password
- the password.useSSL
- use SSL.keyStore
- the key store resource (e.g. "file:/foo/keystore").trustStore
- the trust store resource (e.g. "file:/foo/truststore").keyStorePassPhrase
- the pass phrase for the key store.trustStorePassPhrase
- the pass phrase for the trust store.
-
LocalizedQueueConnectionFactory
public LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, String[] addresses, String[] adminUris, String[] nodes, String vhost, String username, String password, boolean useSSL, @Nullable Resource sslPropertiesLocation)
- Parameters:
defaultConnectionFactory
- the fallback connection factory to use if the queue can't be located.addresses
- the rabbitmq server addresses (host:port, ...).adminUris
- the rabbitmq admin addresses (https://host:port, ...)nodes
- the rabbitmq nodes corresponding to addresses (rabbit@server1, ...) must be the same length as addresses.vhost
- the virtual host.username
- the user name.password
- the password.useSSL
- use SSL.sslPropertiesLocation
- the SSL properties location.
-
LocalizedQueueConnectionFactory
public LocalizedQueueConnectionFactory(ConnectionFactory defaultConnectionFactory, String[] addresses, String[] adminUris, String[] nodes, String vhost, String username, String password, boolean useSSL, String keyStore, String trustStore, String keyStorePassPhrase, String trustStorePassPhrase)
- Parameters:
defaultConnectionFactory
- the fallback connection factory to use if the queue can't be located.addresses
- the rabbitmq server addresses (host:port, ...).adminUris
- the rabbitmq admin addresses (https://host:port, ...).nodes
- the rabbitmq nodes corresponding to addresses (rabbit@server1, ...) must be the same length as addresses.vhost
- the virtual host.username
- the user name.password
- the password.useSSL
- use SSL.keyStore
- the key store resource (e.g. "file:/foo/keystore").trustStore
- the trust store resource (e.g. "file:/foo/truststore").keyStorePassPhrase
- the pass phrase for the key store.trustStorePassPhrase
- the pass phrase for the trust store.
-
-
Method Detail
-
createConnection
public Connection createConnection() throws AmqpException
- Specified by:
createConnection
in interfaceConnectionFactory
- Throws:
AmqpException
-
getHost
public String getHost()
- Specified by:
getHost
in interfaceConnectionFactory
-
getPort
public int getPort()
- Specified by:
getPort
in interfaceConnectionFactory
-
getVirtualHost
public String getVirtualHost()
- Specified by:
getVirtualHost
in interfaceConnectionFactory
-
getUsername
public String getUsername()
- Specified by:
getUsername
in interfaceConnectionFactory
-
addConnectionListener
public void addConnectionListener(ConnectionListener listener)
- Specified by:
addConnectionListener
in interfaceConnectionFactory
-
removeConnectionListener
public boolean removeConnectionListener(ConnectionListener listener)
- Specified by:
removeConnectionListener
in interfaceConnectionFactory
-
clearConnectionListeners
public void clearConnectionListeners()
- Specified by:
clearConnectionListeners
in interfaceConnectionFactory
-
getTargetConnectionFactory
public ConnectionFactory getTargetConnectionFactory(Object key)
Description copied from interface:RoutingConnectionFactory
Returns theConnectionFactory
bound to given lookup key, or null if one does not exist.- Specified by:
getTargetConnectionFactory
in interfaceRoutingConnectionFactory
- Parameters:
key
- The lookup key to which theConnectionFactory
is bound- Returns:
- the
ConnectionFactory
bound to the given lookup key, or null if one does not exist
-
createClient
protected com.rabbitmq.http.client.Client createClient(String adminUri, String username, String password) throws MalformedURLException, URISyntaxException
Create a client instance.- Parameters:
adminUri
- the admin URI.username
- the usernamepassword
- the password.- Returns:
- The client.
- Throws:
MalformedURLException
- if the URL is malformedURISyntaxException
- if there is a syntax error.
-
createConnectionFactory
protected ConnectionFactory createConnectionFactory(String address, String node)
Create a dedicated connection factory for the address.- Parameters:
address
- the address to which the factory should connect.node
- the node.- Returns:
- the connection factory.
-
resetConnection
public void resetConnection()
Description copied from interface:ConnectionFactory
Close any connection(s) that might be cached by this factory. This does not prevent new connections from being opened.- Specified by:
resetConnection
in interfaceConnectionFactory
-
destroy
public void destroy()
- Specified by:
destroy
in interfaceDisposableBean
-
-