org.springframework.boot.autoconfigure.amqp

Class RabbitProperties

java.lang.Object

org.springframework.boot.autoconfigure.amqp.RabbitProperties

@ConfigurationProperties(prefix="spring.rabbitmq")
public class RabbitProperties
extends Object

Configuration properties for Rabbit.

Since:

1.0.0

Author:

Greg Turnquist, Dave Syer, Stephane Nicoll, Andy Wilkinson, Josh Thornhill, Gary Russell, Artsiom Yudovin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RabbitProperties.AmqpContainer
static class	RabbitProperties.Cache
static class	RabbitProperties.ContainerType
static class	RabbitProperties.DirectContainer Configuration properties for DirectMessageListenerContainer.
static class	RabbitProperties.Listener
static class	RabbitProperties.ListenerRetry
static class	RabbitProperties.Retry
static class	RabbitProperties.SimpleContainer Configuration properties for SimpleMessageListenerContainer.
class	RabbitProperties.Ssl
static class	RabbitProperties.Template

Constructor Summary

Constructors

Constructor and Description
RabbitProperties()

Method Summary

Modifier and Type	Method and Description
String	determineAddresses() Returns the comma-separated addresses or a single address (host:port) created from the configured host and port if no addresses have been set.
String	determineHost() Returns the host from the first address, or the configured host if no addresses have been set.
String	determinePassword() If addresses have been set and the first address has a password it is returned.
int	determinePort() Returns the port from the first address, or the configured port if no addresses have been set.
String	determineUsername() If addresses have been set and the first address has a username it is returned.
String	determineVirtualHost() If addresses have been set and the first address has a virtual host it is returned.
String	getAddresses()
RabbitProperties.Cache	getCache()
Duration	getConnectionTimeout()
String	getHost()
RabbitProperties.Listener	getListener()
String	getPassword()
int	getPort()
org.springframework.amqp.rabbit.connection.CachingConnectionFactory.ConfirmType	getPublisherConfirmType()
Duration	getRequestedHeartbeat()
RabbitProperties.Ssl	getSsl()
RabbitProperties.Template	getTemplate()
String	getUsername()
String	getVirtualHost()
boolean	isPublisherConfirms() Deprecated.
boolean	isPublisherReturns()
void	setAddresses(String addresses)
void	setConnectionTimeout(Duration connectionTimeout)
void	setHost(String host)
void	setPassword(String password)
void	setPort(int port)
void	setPublisherConfirms(boolean publisherConfirms) Deprecated.
void	setPublisherConfirmType(org.springframework.amqp.rabbit.connection.CachingConnectionFactory.ConfirmType publisherConfirmType)
void	setPublisherReturns(boolean publisherReturns)
void	setRequestedHeartbeat(Duration requestedHeartbeat)
void	setUsername(String username)
void	setVirtualHost(String virtualHost)

Methods inherited from class java.lang.Object

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

Constructor Detail

RabbitProperties

public RabbitProperties()

Method Detail

getHost

public String getHost()

determineHost

public String determineHost()

Returns the host from the first address, or the configured host if no addresses have been set.

Returns:

the host

See Also:

setAddresses(String), getHost()

setHost

public void setHost(String host)

getPort

public int getPort()

determinePort

public int determinePort()

Returns the port from the first address, or the configured port if no addresses have been set.

Returns:

the port

See Also:

setAddresses(String), getPort()

setPort

public void setPort(int port)

getAddresses

public String getAddresses()

determineAddresses

public String determineAddresses()

Returns the comma-separated addresses or a single address (host:port) created from the configured host and port if no addresses have been set.

Returns:

the addresses

setAddresses

public void setAddresses(String addresses)

getUsername

public String getUsername()

determineUsername

public String determineUsername()

If addresses have been set and the first address has a username it is returned. Otherwise returns the result of calling getUsername().

Returns:

the username

See Also:

setAddresses(String), getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

determinePassword

public String determinePassword()

If addresses have been set and the first address has a password it is returned. Otherwise returns the result of calling getPassword().

Returns:

the password or null

See Also:

setAddresses(String), getPassword()

setPassword

public void setPassword(String password)

getSsl

public RabbitProperties.Ssl getSsl()

getVirtualHost

public String getVirtualHost()

determineVirtualHost

public String determineVirtualHost()

If addresses have been set and the first address has a virtual host it is returned. Otherwise returns the result of calling getVirtualHost().

Returns:

the virtual host or null

See Also:

setAddresses(String), getVirtualHost()

setVirtualHost

public void setVirtualHost(String virtualHost)

getRequestedHeartbeat

public Duration getRequestedHeartbeat()

setRequestedHeartbeat

public void setRequestedHeartbeat(Duration requestedHeartbeat)

isPublisherConfirms

@DeprecatedConfigurationProperty(reason="Replaced to support additional confirm types.",
                                 replacement="spring.rabbitmq.publisher-confirm-type")
 @Deprecated
public boolean isPublisherConfirms()

Deprecated.

setPublisherConfirms

@Deprecated
public void setPublisherConfirms(boolean publisherConfirms)

Deprecated.

isPublisherReturns

public boolean isPublisherReturns()

setPublisherReturns

public void setPublisherReturns(boolean publisherReturns)

getConnectionTimeout

public Duration getConnectionTimeout()

setPublisherConfirmType

public void setPublisherConfirmType(org.springframework.amqp.rabbit.connection.CachingConnectionFactory.ConfirmType publisherConfirmType)

getPublisherConfirmType

public org.springframework.amqp.rabbit.connection.CachingConnectionFactory.ConfirmType getPublisherConfirmType()

setConnectionTimeout

public void setConnectionTimeout(Duration connectionTimeout)

getCache

public RabbitProperties.Cache getCache()

getListener

public RabbitProperties.Listener getListener()

getTemplate

public RabbitProperties.Template getTemplate()