Class RabbitGatewaySupport

java.lang.Object

org.springframework.amqp.rabbit.core.RabbitGatewaySupport

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class RabbitGatewaySupport
extends Object
implements org.springframework.beans.factory.InitializingBean

Convenient super class for application classes that need RabbitMQ access.

Requires a ConnectionFactory or a RabbitTemplate instance to be set. It will create its own RabbitTemplate if a ConnectionFactory is passed in. A custom RabbitTemplate instance can be created for a given ConnectionFactory through overriding the createRabbitTemplate(ConnectionFactory) method.

See Also:

• setConnectionFactory(ConnectionFactory)
• setRabbitOperations(RabbitOperations)
• createRabbitTemplate(ConnectionFactory)
• RabbitTemplate

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.commons.logging.Log	logger	Logger available to subclasses.

Constructor Summary

Constructors

Constructor	Description
RabbitGatewaySupport()

Method Summary

Modifier and Type	Method	Description
final void	afterPropertiesSet()
protected RabbitTemplate	createRabbitTemplate(ConnectionFactory connectionFactory)	Create a RabbitTemplate for the given ConnectionFactory.
final @Nullable ConnectionFactory	getConnectionFactory()
final @Nullable RabbitOperations	getRabbitOperations()
protected void	initGateway()	Subclasses can override this for custom initialization behavior.
final void	setConnectionFactory(ConnectionFactory connectionFactory)	Set the Rabbit connection factory to be used by the gateway.
final void	setRabbitOperations(RabbitOperations rabbitOperations)	Set the RabbitOperations for the gateway.

Methods inherited from class Object

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

Field Details

logger

protected final org.apache.commons.logging.Log logger

Logger available to subclasses.

Constructor Details

RabbitGatewaySupport

public RabbitGatewaySupport()

Method Details

setConnectionFactory

public final void setConnectionFactory(ConnectionFactory connectionFactory)

Set the Rabbit connection factory to be used by the gateway. Will automatically create a RabbitTemplate for the given ConnectionFactory.

Parameters:

connectionFactory - The connection factory.

See Also:

• createRabbitTemplate(ConnectionFactory)
• setConnectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory)

createRabbitTemplate

protected RabbitTemplate createRabbitTemplate(ConnectionFactory connectionFactory)

Create a RabbitTemplate for the given ConnectionFactory. Only invoked if populating the gateway with a ConnectionFactory reference.

Parameters:

connectionFactory - the Rabbit ConnectionFactory to create a RabbitTemplate for

Returns:

the new RabbitTemplate instance

See Also:

• setConnectionFactory(ConnectionFactory)

getConnectionFactory

public final @Nullable ConnectionFactory getConnectionFactory()

Returns:

The Rabbit ConnectionFactory used by the gateway.

setRabbitOperations

public final void setRabbitOperations(RabbitOperations rabbitOperations)

Set the RabbitOperations for the gateway.

Parameters:

rabbitOperations - The Rabbit operations.

See Also:

• setConnectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory)

getRabbitOperations

public final @Nullable RabbitOperations getRabbitOperations()

Returns:

The RabbitOperations for the gateway.

afterPropertiesSet

public final void afterPropertiesSet()
                              throws IllegalArgumentException,
org.springframework.beans.factory.BeanInitializationException

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

IllegalArgumentException

org.springframework.beans.factory.BeanInitializationException

initGateway

protected void initGateway()

Subclasses can override this for custom initialization behavior. Gets called after population of this instance's bean properties.