@ManagedResource public class CachingConnectionFactory extends AbstractConnectionFactory implements org.springframework.beans.factory.InitializingBean, com.rabbitmq.client.ShutdownListener, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextClosedEvent>, PublisherCallbackChannelConnectionFactory
ConnectionFactory
implementation that (when the cache mode is CachingConnectionFactory.CacheMode.CHANNEL
(default)
returns the same Connection from all createConnection()
calls, and ignores calls to Connection.close()
and caches
Channel
.
By default, only one Channel will be cached, with further requested Channels being created and disposed on demand.
Consider raising the "channelCacheSize" value
in case of a high-concurrency
environment.
When the cache mode is CachingConnectionFactory.CacheMode.CONNECTION
, a new (or cached) connection is used for each createConnection()
;
connections are cached according to the "connectionCacheSize" value
.
Both connections and channels are cached in this mode.
CachingConnectionFactory.CacheMode.CONNECTION
is not compatible with a Rabbit Admin that auto-declares queues etc.
NOTE: This ConnectionFactory requires explicit closing of all Channels obtained form its Connection(s).
This is the usual recommendation for native Rabbit access code anyway. However, with this ConnectionFactory, its use
is mandatory in order to actually allow for Channel reuse. Channel.close()
returns the channel to the
cache, if there is room, or physically closes the channel otherwise.
Modifier and Type | Class and Description |
---|---|
static class |
CachingConnectionFactory.CacheMode |
DEFAULT_CLOSE_TIMEOUT, logger
Constructor and Description |
---|
CachingConnectionFactory()
Create a new CachingConnectionFactory initializing the hostname to be the value returned from
InetAddress.getLocalHost(), or "localhost" if getLocalHost() throws an exception.
|
CachingConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory)
Create a new CachingConnectionFactory for the given target ConnectionFactory.
|
CachingConnectionFactory(int port)
Create a new CachingConnectionFactory given a port on the hostname returned from
InetAddress.getLocalHost(), or "localhost" if getLocalHost() throws an exception.
|
CachingConnectionFactory(java.lang.String hostname)
Create a new CachingConnectionFactory given a host name.
|
CachingConnectionFactory(java.lang.String hostname,
int port)
Create a new CachingConnectionFactory given a host name
and port.
|
CachingConnectionFactory(java.net.URI uri)
Create a new CachingConnectionFactory given a
URI . |
Modifier and Type | Method and Description |
---|---|
void |
addConnectionListener(ConnectionListener listener) |
void |
afterPropertiesSet() |
Connection |
createConnection() |
void |
destroy()
Close the underlying shared connection.
|
CachingConnectionFactory.CacheMode |
getCacheMode() |
java.util.Properties |
getCacheProperties() |
int |
getChannelCacheSize() |
int |
getConnectionCachesize()
Deprecated.
|
int |
getConnectionCacheSize() |
protected java.util.concurrent.ExecutorService |
getDeferredCloseExecutor()
Determine the executor service used to close connections.
|
int |
getPhase()
Deprecated.
- no longer used.
|
boolean |
isAutoStartup()
Deprecated.
- no longer used.
|
boolean |
isPublisherConfirms() |
boolean |
isPublisherReturns() |
boolean |
isRunning()
Deprecated.
- no longer used.
|
void |
onApplicationEvent(org.springframework.context.event.ContextClosedEvent event) |
protected void |
reset(java.util.List<ChannelProxy> channels,
java.util.List<ChannelProxy> txChannels) |
void |
resetConnection()
Close the connection(s).
|
void |
setApplicationContext(org.springframework.context.ApplicationContext applicationContext) |
void |
setCacheMode(CachingConnectionFactory.CacheMode cacheMode) |
void |
setChannelCacheSize(int sessionCacheSize)
The number of channels to maintain in the cache.
|
void |
setChannelCheckoutTimeout(long channelCheckoutTimeout)
Sets the channel checkout timeout.
|
void |
setCloseExceptionLogger(ConditionalExceptionLogger closeExceptionLogger)
Set the strategy for logging close exceptions; by default, if a channel is closed due to a failed
passive queue declaration, it is logged at debug level.
|
void |
setConnectionCacheSize(int connectionCacheSize) |
void |
setConnectionLimit(int connectionLimit)
Set the connection limit when using cache mode CONNECTION.
|
void |
setConnectionListeners(java.util.List<? extends ConnectionListener> listeners) |
void |
setPhase(int phase)
Deprecated.
- no longer used.
|
void |
setPublisherConfirms(boolean publisherConfirms) |
void |
setPublisherReturns(boolean publisherReturns) |
void |
shutdownCompleted(com.rabbitmq.client.ShutdownSignalException cause) |
void |
start()
Deprecated.
- no longer used.
|
void |
stop()
Deprecated.
- no longer used.
|
void |
stop(java.lang.Runnable callback)
Deprecated.
- no longer used.
|
java.lang.String |
toString() |
addChannelListener, clearConnectionListeners, createBareConnection, getBeanName, getChannelListener, getCloseTimeout, getConnectionListener, getDefaultHostName, getExecutorService, getHost, getPort, getRabbitConnectionFactory, getUsername, getVirtualHost, removeConnectionListener, setAddresses, setBeanName, setChannelListeners, setCloseTimeout, setConnectionNameStrategy, setConnectionThreadFactory, setConnectionTimeout, setExecutor, setHost, setPassword, setPort, setRecoveryListener, setRequestedHeartBeat, setUri, setUri, setUsername, setVirtualHost
public CachingConnectionFactory()
public CachingConnectionFactory(java.lang.String hostname, int port)
hostname
- the host name to connect toport
- the port numberpublic CachingConnectionFactory(java.net.URI uri)
URI
.uri
- the amqp uri configuring the connectionpublic CachingConnectionFactory(int port)
port
- the port numberpublic CachingConnectionFactory(java.lang.String hostname)
hostname
- the host name to connect topublic CachingConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory)
rabbitConnectionFactory
- the target ConnectionFactorypublic void setChannelCacheSize(int sessionCacheSize)
setChannelCheckoutTimeout(long)
.sessionCacheSize
- the channel cache size.setChannelCheckoutTimeout(long)
public int getChannelCacheSize()
public CachingConnectionFactory.CacheMode getCacheMode()
public void setCacheMode(CachingConnectionFactory.CacheMode cacheMode)
@Deprecated public int getConnectionCachesize()
public int getConnectionCacheSize()
public void setConnectionCacheSize(int connectionCacheSize)
public void setConnectionLimit(int connectionLimit)
channelCheckoutTimeLimit
is used to wait
for a connection to become idle.connectionLimit
- the limit.public boolean isPublisherConfirms()
isPublisherConfirms
in interface PublisherCallbackChannelConnectionFactory
public boolean isPublisherReturns()
isPublisherReturns
in interface PublisherCallbackChannelConnectionFactory
public void setPublisherReturns(boolean publisherReturns)
public void setPublisherConfirms(boolean publisherConfirms)
public void setChannelCheckoutTimeout(long channelCheckoutTimeout)
channelCacheSize
becomes the total number of available channels per
connection rather than a simple cache size. Note that changing the channelCacheSize
does not affect the limit on existing connection(s), invoke destroy()
to cause a
new connection to be created with the new limit.
Since 1.5.5, also applies to getting a connection when the cache mode is CONNECTION.
channelCheckoutTimeout
- the timeout in milliseconds; default 0 (channel limiting not enabled).setConnectionLimit(int)
public void setCloseExceptionLogger(ConditionalExceptionLogger closeExceptionLogger)
closeExceptionLogger
- the ConditionalExceptionLogger
.public void afterPropertiesSet() throws java.lang.Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
java.lang.Exception
public void setConnectionListeners(java.util.List<? extends ConnectionListener> listeners)
setConnectionListeners
in class AbstractConnectionFactory
public void addConnectionListener(ConnectionListener listener)
addConnectionListener
in interface ConnectionFactory
addConnectionListener
in class AbstractConnectionFactory
public void shutdownCompleted(com.rabbitmq.client.ShutdownSignalException cause)
shutdownCompleted
in interface com.rabbitmq.client.ShutdownListener
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException
setApplicationContext
in interface org.springframework.context.ApplicationContextAware
org.springframework.beans.BeansException
public void onApplicationEvent(org.springframework.context.event.ContextClosedEvent event)
onApplicationEvent
in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextClosedEvent>
public final Connection createConnection() throws AmqpException
createConnection
in interface ConnectionFactory
AmqpException
public final void destroy()
resetConnection()
to close the
connection while the application is still running.
As this bean implements DisposableBean, a bean factory will automatically invoke this on destruction of its cached singletons.
If called after the context is closed, the connection factory can no longer server up connections.
destroy
in interface org.springframework.beans.factory.DisposableBean
destroy
in class AbstractConnectionFactory
public void resetConnection()
@Deprecated public void start()
@Deprecated public boolean isRunning()
@Deprecated public int getPhase()
@Deprecated public void setPhase(int phase)
phase
- the phase.getPhase()
@Deprecated public boolean isAutoStartup()
@Deprecated public void stop()
@Deprecated public void stop(java.lang.Runnable callback)
callback
- the callback.protected void reset(java.util.List<ChannelProxy> channels, java.util.List<ChannelProxy> txChannels)
@ManagedAttribute public java.util.Properties getCacheProperties()
protected java.util.concurrent.ExecutorService getDeferredCloseExecutor()
public java.lang.String toString()
toString
in class AbstractConnectionFactory