org.springframework.amqp.rabbit.connection

Class RabbitConnectionFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<com.rabbitmq.client.ConnectionFactory>

org.springframework.amqp.rabbit.connection.RabbitConnectionFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<com.rabbitmq.client.ConnectionFactory>, InitializingBean

public class RabbitConnectionFactoryBean
extends AbstractFactoryBean<com.rabbitmq.client.ConnectionFactory>

Factory bean to create a RabbitMQ ConnectionFactory, delegating most setter methods and optionally enabling SSL, with or without certificate validation. When sslPropertiesLocation is not null, the default implementation loads a PKCS12 keystore and a JKS truststore using the supplied properties and intializes SunX509 key and trust manager factories. These are then used to initialize an SSLContext using the sslAlgorithm (default TLSv1.1).

Override createSSLContext() to create and/or perform further modification of the context.

Override setUpSSL() to take complete control over setting up SSL.

Since:

1.4

Author:

Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
protected com.rabbitmq.client.ConnectionFactory	connectionFactory

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
RabbitConnectionFactoryBean()

Method Summary

Modifier and Type	Method and Description
protected com.rabbitmq.client.ConnectionFactory	createInstance()
protected SSLContext	createSSLContext() Override this method to create and/or configure the SSLContext used by the ConnectionFactory.
protected String	getKeyStore()
protected String	getKeyStorePassphrase()
Class<?>	getObjectType()
protected String	getSslAlgorithm()
protected Resource	getSslPropertiesLocation()
protected String	getTrustStore()
protected String	getTrustStorePassphrase()
protected boolean	isUseSSL()
void	setClientProperties(Map<String,Object> clientProperties) Add custom client properties.
void	setConnectionTimeout(int connectionTimeout)
void	setExceptionHandler(com.rabbitmq.client.ExceptionHandler exceptionHandler)
void	setHost(String host)
void	setKeyStore(String keyStore) Set the key store resource (e.g.
void	setKeyStorePassphrase(String keyStorePassphrase) Set the key store pass phrase - overrides the property in setSslPropertiesLocation(Resource).
void	setPassword(String password)
void	setPort(int port)
void	setRequestedChannelMax(int requestedChannelMax)
void	setRequestedFrameMax(int requestedFrameMax)
void	setRequestedHeartbeat(int requestedHeartbeat)
void	setSaslConfig(com.rabbitmq.client.SaslConfig saslConfig)
void	setSharedExecutor(ExecutorService executor)
void	setSocketConfigurator(com.rabbitmq.client.SocketConfigurator socketConfigurator)
void	setSocketFactory(SocketFactory factory)
void	setSslAlgorithm(String sslAlgorithm) Set the algorithm to use; default TLSv1.1.
void	setSslPropertiesLocation(Resource sslPropertiesLocation) When setUseSSL(boolean) is true, the SSL properties to use (optional).
void	setThreadFactory(ThreadFactory threadFactory)
void	setTrustStore(String trustStore) Set the key store resource (e.g.
void	setTrustStorePassphrase(String trustStorePassphrase) Set the trust store pass phrase - overrides the property in setSslPropertiesLocation(Resource).
protected void	setUpSSL() Override this method to take complete control over the SSL setup.
void	setUri(String uriString)
void	setUri(URI uri)
void	setUsername(String username)
void	setUseSSL(boolean useSSL) Whether or not the factory should be configured to use SSL.
void	setVirtualHost(String virtualHost)

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Field Detail

connectionFactory

protected final com.rabbitmq.client.ConnectionFactory connectionFactory

Constructor Detail

RabbitConnectionFactoryBean

public RabbitConnectionFactoryBean()

Method Detail

setUseSSL

public void setUseSSL(boolean useSSL)

Whether or not the factory should be configured to use SSL.

Parameters:

useSSL - true to use SSL.

isUseSSL

protected boolean isUseSSL()

Returns:

true to use ssl.

Since:

1.4.4.

setSslAlgorithm

public void setSslAlgorithm(String sslAlgorithm)

Set the algorithm to use; default TLSv1.1.

Parameters:

sslAlgorithm - the algorithm.

getSslAlgorithm

protected String getSslAlgorithm()

Returns:

the ssl algorithm.

Since:

1.4.4

setSslPropertiesLocation

public void setSslPropertiesLocation(Resource sslPropertiesLocation)

When setUseSSL(boolean) is true, the SSL properties to use (optional). Resource referencing a properties file with the following properties:

• keyStore=file:/secret/keycert.p12
• trustStore=file:/secret/trustStore
• keyStore.passPhrase=secret
• trustStore.passPhrase=secret

If this is provided, its properties (if present) will override the explicitly set property in this bean.

Parameters:

sslPropertiesLocation - the Resource to the ssl properties

getSslPropertiesLocation

protected Resource getSslPropertiesLocation()

Returns:

the properties location.

Since:

1.4.4

getKeyStore

protected String getKeyStore()

Returns:

the key store resource.

Since:

1.5

setKeyStore

public void setKeyStore(String keyStore)

Set the key store resource (e.g. file:/foo/keystore) - overrides the property in setSslPropertiesLocation(Resource).

Parameters:

keyStore - the keystore resource.

Since:

1.5

getTrustStore

protected String getTrustStore()

Returns:

the trust store resource.

Since:

1.5

setTrustStore

public void setTrustStore(String trustStore)

Set the key store resource (e.g. file:/foo/truststore) - overrides the property in setSslPropertiesLocation(Resource).

Parameters:

trustStore - the keystore resource.

Since:

1.5

getKeyStorePassphrase

protected String getKeyStorePassphrase()

Returns:

the key store pass phrase.

Since:

1.5

setKeyStorePassphrase

public void setKeyStorePassphrase(String keyStorePassphrase)

Set the key store pass phrase - overrides the property in setSslPropertiesLocation(Resource).

Parameters:

keyStorePassphrase - the key store pass phrase.

Since:

1.5

getTrustStorePassphrase

protected String getTrustStorePassphrase()

Returns:

the trust store pass phrase.

Since:

1.5

setTrustStorePassphrase

public void setTrustStorePassphrase(String trustStorePassphrase)

Set the trust store pass phrase - overrides the property in setSslPropertiesLocation(Resource).

Parameters:

trustStorePassphrase - the trust store pass phrase.

Since:

1.5

setHost

public void setHost(String host)

Parameters:

host - the host.

See Also:

ConnectionFactory.setHost(java.lang.String)

setPort

public void setPort(int port)

Parameters:

port - the port.

See Also:

ConnectionFactory.setPort(int)

setUsername

public void setUsername(String username)

Parameters:

username - the user name.

See Also:

ConnectionFactory.setUsername(java.lang.String)

setPassword

public void setPassword(String password)

Parameters:

password - the password.

See Also:

ConnectionFactory.setPassword(java.lang.String)

setVirtualHost

public void setVirtualHost(String virtualHost)

Parameters:

virtualHost - the virtual host.

See Also:

ConnectionFactory.setVirtualHost(java.lang.String)

setUri

public void setUri(URI uri)
            throws URISyntaxException,
                   NoSuchAlgorithmException,
                   KeyManagementException

Parameters:

uri - the uri.

Throws:

URISyntaxException - invalid syntax.

NoSuchAlgorithmException - no such algorithm.

KeyManagementException - key management.

See Also:

ConnectionFactory.setUri(java.net.URI)

setUri

public void setUri(String uriString)
            throws URISyntaxException,
                   NoSuchAlgorithmException,
                   KeyManagementException

Parameters:

uriString - the uri.

Throws:

URISyntaxException - invalid syntax.

NoSuchAlgorithmException - no such algorithm.

KeyManagementException - key management.

See Also:

ConnectionFactory.setUri(java.lang.String)

setRequestedChannelMax

public void setRequestedChannelMax(int requestedChannelMax)

Parameters:

requestedChannelMax - the max requested channels.

See Also:

ConnectionFactory.setRequestedChannelMax(int)

setRequestedFrameMax

public void setRequestedFrameMax(int requestedFrameMax)

Parameters:

requestedFrameMax - the requested max frames.

See Also:

ConnectionFactory.setRequestedFrameMax(int)

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Parameters:

connectionTimeout - the connection timeout.

See Also:

ConnectionFactory.setConnectionTimeout(int)

setRequestedHeartbeat

public void setRequestedHeartbeat(int requestedHeartbeat)

Parameters:

requestedHeartbeat - the requested heartbeat.

See Also:

ConnectionFactory.setRequestedHeartbeat(int)

setClientProperties

public void setClientProperties(Map<String,Object> clientProperties)

Add custom client properties.

Parameters:

clientProperties - the client properties.

See Also:

ConnectionFactory.setClientProperties(java.util.Map)

setSaslConfig

public void setSaslConfig(com.rabbitmq.client.SaslConfig saslConfig)

Parameters:

saslConfig - the sasl config.

See Also:

ConnectionFactory.setSaslConfig(com.rabbitmq.client.SaslConfig)

setSocketFactory

public void setSocketFactory(SocketFactory factory)

Parameters:

factory - the socket factory.

See Also:

ConnectionFactory.setSocketFactory(javax.net.SocketFactory)

setSocketConfigurator

public void setSocketConfigurator(com.rabbitmq.client.SocketConfigurator socketConfigurator)

Parameters:

socketConfigurator - the socket configurator.

See Also:

ConnectionFactory.setSocketConfigurator(com.rabbitmq.client.SocketConfigurator)

setSharedExecutor

public void setSharedExecutor(ExecutorService executor)

Parameters:

executor - the executor service

See Also:

ConnectionFactory.setSharedExecutor(java.util.concurrent.ExecutorService)

setThreadFactory

public void setThreadFactory(ThreadFactory threadFactory)

Parameters:

threadFactory - the thread factory.

See Also:

ConnectionFactory.setThreadFactory(java.util.concurrent.ThreadFactory)

setExceptionHandler

public void setExceptionHandler(com.rabbitmq.client.ExceptionHandler exceptionHandler)

Parameters:

exceptionHandler - the exception handler.

See Also:

ConnectionFactory.setExceptionHandler(com.rabbitmq.client.ExceptionHandler)

getObjectType

public Class<?> getObjectType()

Specified by:

getObjectType in interface FactoryBean<com.rabbitmq.client.ConnectionFactory>

Specified by:

getObjectType in class AbstractFactoryBean<com.rabbitmq.client.ConnectionFactory>

createInstance

protected com.rabbitmq.client.ConnectionFactory createInstance()
                                                        throws Exception

Specified by:

createInstance in class AbstractFactoryBean<com.rabbitmq.client.ConnectionFactory>

Throws:

Exception

setUpSSL

protected void setUpSSL()
                 throws Exception

Override this method to take complete control over the SSL setup.

Throws:

Exception - an Exception.

Since:

1.4.4

createSSLContext

protected SSLContext createSSLContext()
                               throws NoSuchAlgorithmException

Override this method to create and/or configure the SSLContext used by the ConnectionFactory.

Returns:

The SSLContext.

Throws:

NoSuchAlgorithmException - if the algorithm is not available.

Since:

1.4.4