Package org.springframework.amqp.rabbit.connection

Class ThreadChannelConnectionFactory

java.lang.Object

org.springframework.amqp.rabbit.connection.AbstractConnectionFactory

org.springframework.amqp.rabbit.connection.ThreadChannelConnectionFactory

All Implemented Interfaces:

com.rabbitmq.client.ShutdownListener, EventListener, ConnectionFactory, Aware, BeanNameAware, DisposableBean, ApplicationContextAware, ApplicationEventPublisherAware, ApplicationListener<ContextClosedEvent>, Lifecycle, Phased, SmartLifecycle

public class ThreadChannelConnectionFactory
extends AbstractConnectionFactory
implements com.rabbitmq.client.ShutdownListener, SmartLifecycle

A very simple connection factory that caches a channel per thread. Users are responsible for releasing the thread's channel by calling closeThreadChannel().

Since:

2.3

Author:

Gary Russell, Leonardo Ferreira, Christian Tzolov, Ngoc Nhan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.amqp.rabbit.connection.AbstractConnectionFactory

AbstractConnectionFactory.AddressShuffleMode, AbstractConnectionFactory.DefaultChannelCloseLogger

Field Summary

Fields inherited from class org.springframework.amqp.rabbit.connection.AbstractConnectionFactory

DEFAULT_CLOSE_TIMEOUT, logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ThreadChannelConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory)	Construct an instance.

Method Summary

Modifier and Type	Method	Description
void	addConnectionListener(ConnectionListener listener)
void	closeThreadChannel()	Close the channel associated with this thread, if any.
Connection	createConnection()
void	destroy()
int	getPhase()
boolean	isRunning()
boolean	isSimplePublisherConfirms()	Return true if simple publisher confirms are enabled.
Object	prepareSwitchContext()	Call to prepare to switch the channel(s) owned by this thread to another thread.
void	resetConnection()	Close the connection(s).
void	setPublisherConnectionFactory(AbstractConnectionFactory publisherConnectionFactory)	Set a custom publisher connection factory; the type does not need to be the same as this factory.
void	setSimplePublisherConfirms(boolean simplePublisherConfirms)	Enable simple publisher confirms.
void	start()
void	stop()
void	switchContext(Object toSwitch)	Acquire ownership of another thread's channel(s) after that thread called prepareSwitchContext().

Methods inherited from class org.springframework.amqp.rabbit.connection.AbstractConnectionFactory

addChannelListener, clearConnectionListeners, createBareConnection, doSetPublisherConnectionFactory, getAddresses, getApplicationContext, getApplicationEventPublisher, getBeanName, getChannelListener, getCloseTimeout, getConnectionListener, getConnectionNameStrategy, getContextStopped, getDefaultHostName, getExecutorService, getHost, getPort, getPublisherConnectionFactory, getRabbitConnectionFactory, getUsername, getVirtualHost, hasPublisherConnectionFactory, onApplicationEvent, removeConnectionListener, setAddresses, setAddressResolver, setAddressShuffleMode, setApplicationContext, setApplicationEventPublisher, setBeanName, setChannelListeners, setCloseExceptionLogger, setCloseTimeout, setConnectionCreatingBackOff, setConnectionListeners, setConnectionNameStrategy, setConnectionThreadFactory, setConnectionTimeout, setExecutor, setHost, setPassword, setPort, setRecoveryListener, setRequestedHeartBeat, setUri, setUri, setUsername, setVirtualHost, shutdownCompleted, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Methods inherited from interface org.springframework.amqp.rabbit.connection.ConnectionFactory

isPublisherConfirms, isPublisherReturns

Methods inherited from interface com.rabbitmq.client.ShutdownListener

shutdownCompleted

Methods inherited from interface org.springframework.context.SmartLifecycle

isAutoStartup, stop

Constructor Details

ThreadChannelConnectionFactory

public ThreadChannelConnectionFactory(com.rabbitmq.client.ConnectionFactory rabbitConnectionFactory)

Construct an instance.

Parameters:

rabbitConnectionFactory - the rabbitmq connection factory.

Method Details

setPublisherConnectionFactory

public void setPublisherConnectionFactory(@Nullable
 AbstractConnectionFactory publisherConnectionFactory)

Description copied from class: AbstractConnectionFactory

Set a custom publisher connection factory; the type does not need to be the same as this factory.

Overrides:

setPublisherConnectionFactory in class AbstractConnectionFactory

Parameters:

publisherConnectionFactory - the factory.

isSimplePublisherConfirms

public boolean isSimplePublisherConfirms()

Description copied from interface: ConnectionFactory

Return true if simple publisher confirms are enabled.

Specified by:

isSimplePublisherConfirms in interface ConnectionFactory

Returns:

simplePublisherConfirms

setSimplePublisherConfirms

public void setSimplePublisherConfirms(boolean simplePublisherConfirms)

Enable simple publisher confirms.

Parameters:

simplePublisherConfirms - true to enable.

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

addConnectionListener

public void addConnectionListener(ConnectionListener listener)

Specified by:

addConnectionListener in interface ConnectionFactory

Overrides:

addConnectionListener in class AbstractConnectionFactory

createConnection

public Connection createConnection()
                            throws AmqpException

Specified by:

createConnection in interface ConnectionFactory

Throws:

AmqpException

closeThreadChannel

public void closeThreadChannel()

Close the channel associated with this thread, if any.

resetConnection

public void resetConnection()

Close the connection(s). This will impact any in-process operations. New connection(s) will be created on demand after this method returns. This might be used to force a reconnect to the primary broker after failing over to a secondary broker.

Specified by:

resetConnection in interface ConnectionFactory

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Overrides:

destroy in class AbstractConnectionFactory

prepareSwitchContext

@Nullable
public Object prepareSwitchContext()

Call to prepare to switch the channel(s) owned by this thread to another thread.

Returns:

an opaque object representing the context to switch. If there are no channels or no open channels assigned to this thread, null is returned.

Since:

2.3.7

See Also:

• switchContext(Object)

switchContext

public void switchContext(@Nullable
 Object toSwitch)

Acquire ownership of another thread's channel(s) after that thread called prepareSwitchContext().

Parameters:

toSwitch - the context returned by prepareSwitchContext().

Since:

2.3.7

See Also:

• prepareSwitchContext()