java.lang.Object

net.jodah.lyra.config.Config

All Implemented Interfaces:: ChannelConfig, ConnectionConfig, ConsumerConfig

public class Config
extends java.lang.Object
implements ConnectionConfig

Lyra configuration. Changes are reflected in the resources created with this configuration.

Constructor Summary

Constructors

Constructor Description

Config()

Config(Config parent)
Creates a new Config object that inherits configuration from the parent.

Method Summary

Modifier and Type	Method	Description
`java.util.Collection<ChannelListener>`	`getChannelListeners()`	Returns the channel's listeners else empty list if none were configured.
`RecoveryPolicy`	`getChannelRecoveryPolicy()`	Returns the channel's recovery policy.
`RetryPolicy`	`getChannelRetryPolicy()`	Returns the channel's retry policy.
`java.util.Collection<ConnectionListener>`	`getConnectionListeners()`	Returns the connection's listeners else empty list if none were configured.
`RecoveryPolicy`	`getConnectionRecoveryPolicy()`	Returns the connection's recovery policy.
`RetryPolicy`	`getConnectionRetryPolicy()`	Returns the connection's retry policy.
`RetryPolicy`	`getConnectRetryPolicy()`	Sets the policy to use for handling `connection attempt` errors.
`java.util.Collection<ConsumerListener>`	`getConsumerListeners()`	Returns the consumer listeners else empty list if none were configured.
`java.util.Set<java.lang.Class<? extends java.lang.Exception>>`	`getRecoverableExceptions()`	Returns the exceptions which will be recovered from.
`java.util.Set<java.lang.Class<? extends java.lang.Exception>>`	`getRetryableExceptions()`	Returns the exceptions for which invocations will be retried.
`boolean`	`isConsumerRecoveryEnabled()`	Returns whether consumer recovery is enabled.
`boolean`	`isExchangeRecoveryEnabled()`	Returns whether exchange and exchange binding recovery is enabled.
`boolean`	`isQueueRecoveryEnabled()`	Returns whether queue and queue binding recovery is enabled.
`boolean`	`isUsingDaemonThreads()`	Whether or not using daemon threads.
`static ConfigurableChannel`	`of(com.rabbitmq.client.Channel channel)`	Returns the `channel` as a `ConfigurableChannel`.
`static ConfigurableConnection`	`of(com.rabbitmq.client.Connection connection)`	Returns the `connection` as a `ConfigurableConnection`.
`Config`	`withChannelListeners(ChannelListener... channelListeners)`	Sets the `channelListeners` to call on channel related events.
`Config`	`withChannelRecoveryPolicy(RecoveryPolicy channelRecoveryPolicy)`	Sets the `recoveryPolicy` to use for recovering the channel.
`Config`	`withChannelRetryPolicy(RetryPolicy channelRetryPolicy)`	Sets the `retryPolicy` to use for retrying failed invocations on the channel.
`Config`	`withConnectionListeners(ConnectionListener... connectionListeners)`	Sets the `connectionListeners` to call on connection related events.
`Config`	`withConnectionRecoveryPolicy(RecoveryPolicy connectionRecoveryPolicy)`	Sets the policy to use for the recovery of Connections after an unexpected Connection closure.
`Config`	`withConnectionRetryPolicy(RetryPolicy connectionRetryPolicy)`	Sets the policy to use for handling `Connection` invocation errors.
`Config`	`withConnectRetryPolicy(RetryPolicy connectRetryPolicy)`	Sets the policy to use for handling initial `connection attempt` errors.
`Config`	`withConsumerListeners(ConsumerListener... consumerListeners)`	Sets the `consumerListeners` to call on consumer related events.
`Config`	`withConsumerRecovery(boolean enabled)`	Sets whether consumer recovery is enabled or not.
`Config`	`withExchangeRecovery(boolean enabled)`	Sets whether exchange and exchange binding recovery is enabled or not.
`Config`	`withQueueRecovery(boolean enabled)`	Sets whether queue and queue binding recovery is enabled or not.
`Config`	`withRecoveryPolicy(RecoveryPolicy recoveryPolicy)`	Sets the policy to use for the recovery of Connections/Channels/Consumers after an unexpected Connection/Channel closure.
`Config`	`withRetryPolicy(RetryPolicy retryPolicy)`	Sets the policy to use for handling `connection attempt`, `Connection` invocation, and `Channel` invocation errors.
`Config`	`withUseDaemonThreads(boolean enabled)`	Whether or not using daemon threads.

Methods inherited from class java.lang.Object

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

Constructor Details
- Config
  
  public Config()
- Config
  
  public Config(Config parent)
  
  Creates a new Config object that inherits configuration from the parent.
Method Details
- of
  
  public static ConfigurableChannel of(com.rabbitmq.client.Channel channel)
  
  Returns the channel as a ConfigurableChannel.
  
  Throws:
  
  java.lang.IllegalArgumentException - if channel was not created by Lyra
- of
  
  public static ConfigurableConnection of(com.rabbitmq.client.Connection connection)
  
  Returns the connection as a ConfigurableConnection.
  
  Throws:
  
  java.lang.IllegalArgumentException - if connection was not created by Lyra
- getChannelListeners
  
  public java.util.Collection<ChannelListener> getChannelListeners()
  
  Description copied from interface: ChannelConfig
  
  Returns the channel's listeners else empty list if none were configured.
  
  Specified by:
  
  getChannelListeners in interface ChannelConfig
  
  See Also:
  
  ChannelConfig.withChannelListeners(ChannelListener...)
- getChannelRecoveryPolicy
  
  public RecoveryPolicy getChannelRecoveryPolicy()
  
  Description copied from interface: ChannelConfig
  
  Returns the channel's recovery policy.
  
  Specified by:
  
  getChannelRecoveryPolicy in interface ChannelConfig
  
  See Also:
  
  ChannelConfig.withChannelRecoveryPolicy(RecoveryPolicy)
- getChannelRetryPolicy
  
  public RetryPolicy getChannelRetryPolicy()
  
  Description copied from interface: ChannelConfig
  
  Returns the channel's retry policy.
  
  Specified by:
  
  getChannelRetryPolicy in interface ChannelConfig
  
  See Also:
  
  ChannelConfig.withChannelRetryPolicy(RetryPolicy)
- getConnectionListeners
  
  public java.util.Collection<ConnectionListener> getConnectionListeners()
  
  Description copied from interface: ConnectionConfig
  
  Returns the connection's listeners else empty list if none were configured.
  
  Specified by:
  
  getConnectionListeners in interface ConnectionConfig
  
  See Also:
  
  ConnectionConfig.withConnectionListeners(ConnectionListener...)
- getConnectionRecoveryPolicy
  
  public RecoveryPolicy getConnectionRecoveryPolicy()
  
  Description copied from interface: ConnectionConfig
  
  Returns the connection's recovery policy.
  
  Specified by:
  
  getConnectionRecoveryPolicy in interface ConnectionConfig
  
  See Also:
  
  ConnectionConfig.withConnectionRecoveryPolicy(RecoveryPolicy)
- getConnectionRetryPolicy
  
  public RetryPolicy getConnectionRetryPolicy()
  
  Description copied from interface: ConnectionConfig
  
  Returns the connection's retry policy.
  
  Specified by:
  
  getConnectionRetryPolicy in interface ConnectionConfig
  
  See Also:
  
  ConnectionConfig.withConnectionRetryPolicy(RetryPolicy)
- getConnectRetryPolicy
  
  public RetryPolicy getConnectRetryPolicy()
  
  Sets the policy to use for handling connection attempt errors. Overrides the global retry policy.
  
  See Also:
  
  withConnectRetryPolicy(RetryPolicy), withRetryPolicy(RetryPolicy)
- getConsumerListeners
  
  public java.util.Collection<ConsumerListener> getConsumerListeners()
  
  Description copied from interface: ConsumerConfig
  
  Returns the consumer listeners else empty list if none were configured.
  
  Specified by:
  
  getConsumerListeners in interface ConsumerConfig
  
  See Also:
  
  ConsumerConfig.getConsumerListeners()
- getRecoverableExceptions
  
  public java.util.Set<java.lang.Class<? extends java.lang.Exception>> getRecoverableExceptions()
  
  Returns the exceptions which will be recovered from. By default these will include SocketTimeoutException, ConnectException, AlreadyClosedException, and TimeoutException, but this set can be mutated directly to change the recoverable exceptions.
- getRetryableExceptions
  
  public java.util.Set<java.lang.Class<? extends java.lang.Exception>> getRetryableExceptions()
  
  Returns the exceptions for which invocations will be retried. By default these will include SocketTimeoutException, ConnectException, AlreadyClosedException, and TimeoutException, but this set can be mutated directly to change the retryable exceptions.
- isConsumerRecoveryEnabled
  
  public boolean isConsumerRecoveryEnabled()
  
  Description copied from interface: ConsumerConfig
  
  Returns whether consumer recovery is enabled. Defaults to true when channel recovery is configured.
  
  Specified by:
  
  isConsumerRecoveryEnabled in interface ConsumerConfig
  
  See Also:
  
  ConsumerConfig.withConsumerRecovery(boolean)
- isExchangeRecoveryEnabled
  
  public boolean isExchangeRecoveryEnabled()
  
  Description copied from interface: ChannelConfig
  
  Returns whether exchange and exchange binding recovery is enabled. Any non-durable or auto-deleting exchanges will be recovered unless they are explicitly deleted via Channel.exchangeDelete(String).
  Defaults to true when channel recovery is configured.
  
  Specified by:
  
  isExchangeRecoveryEnabled in interface ChannelConfig
  
  See Also:
  
  ChannelConfig.withExchangeRecovery(boolean)
- isQueueRecoveryEnabled
  
  public boolean isQueueRecoveryEnabled()
  
  Description copied from interface: ChannelConfig
  
  Returns whether queue and queue binding recovery is enabled. Any non-durable or auto-deleting queues will be recovered unless they are explicitly deleted via Channel.queueDelete(String).
  Defaults to true when channel recovery is configured.
  
  Specified by:
  
  isQueueRecoveryEnabled in interface ChannelConfig
  
  See Also:
  
  ChannelConfig.withQueueRecovery(boolean)
- isUsingDaemonThreads
  
  public boolean isUsingDaemonThreads()
  
  Description copied from interface: ConnectionConfig
  
  Whether or not using daemon threads.
  
  Specified by:
  
  isUsingDaemonThreads in interface ConnectionConfig
- withChannelListeners
  
  public Config withChannelListeners(ChannelListener... channelListeners)
  
  Description copied from interface: ChannelConfig
  
  Sets the channelListeners to call on channel related events.
  
  Specified by:
  
  withChannelListeners in interface ChannelConfig
- withChannelRecoveryPolicy
  
  public Config withChannelRecoveryPolicy(RecoveryPolicy channelRecoveryPolicy)
  
  Description copied from interface: ChannelConfig
  
  Sets the recoveryPolicy to use for recovering the channel.
  
  Specified by:
  
  withChannelRecoveryPolicy in interface ChannelConfig
- withChannelRetryPolicy
  
  public Config withChannelRetryPolicy(RetryPolicy channelRetryPolicy)
  
  Description copied from interface: ChannelConfig
  
  Sets the retryPolicy to use for retrying failed invocations on the channel.
  
  Specified by:
  
  withChannelRetryPolicy in interface ChannelConfig
- withConnectionListeners
  
  public Config withConnectionListeners(ConnectionListener... connectionListeners)
  
  Description copied from interface: ConnectionConfig
  
  Sets the connectionListeners to call on connection related events.
  
  Specified by:
  
  withConnectionListeners in interface ConnectionConfig
- withConnectionRecoveryPolicy
  
  public Config withConnectionRecoveryPolicy(RecoveryPolicy connectionRecoveryPolicy)
  
  Description copied from interface: ConnectionConfig
  
  Sets the policy to use for the recovery of Connections after an unexpected Connection closure.
  
  Specified by:
  
  withConnectionRecoveryPolicy in interface ConnectionConfig
- withConnectionRetryPolicy
  
  public Config withConnectionRetryPolicy(RetryPolicy connectionRetryPolicy)
  
  Description copied from interface: ConnectionConfig
  
  Sets the policy to use for handling Connection invocation errors.
  
  Specified by:
  
  withConnectionRetryPolicy in interface ConnectionConfig
- withConnectRetryPolicy
  
  public Config withConnectRetryPolicy(RetryPolicy connectRetryPolicy)
  
  Sets the policy to use for handling initial connection attempt errors. Overrides the global retry policy.
- withConsumerListeners
  
  public Config withConsumerListeners(ConsumerListener... consumerListeners)
  
  Description copied from interface: ConsumerConfig
  
  Sets the consumerListeners to call on consumer related events.
  
  Specified by:
  
  withConsumerListeners in interface ConsumerConfig
- withConsumerRecovery
  
  public Config withConsumerRecovery(boolean enabled)
  
  Description copied from interface: ConsumerConfig
  
  Sets whether consumer recovery is enabled or not.
  
  Specified by:
  
  withConsumerRecovery in interface ConsumerConfig
- withExchangeRecovery
  
  public Config withExchangeRecovery(boolean enabled)
  
  Description copied from interface: ChannelConfig
  
  Sets whether exchange and exchange binding recovery is enabled or not. Any non-durable or auto-deleting exchanges will be recovered unless they are explicitly deleted via Channel.exchangeDelete(String).
  
  Specified by:
  
  withExchangeRecovery in interface ChannelConfig
- withQueueRecovery
  
  public Config withQueueRecovery(boolean enabled)
  
  Description copied from interface: ChannelConfig
  
  Sets whether queue and queue binding recovery is enabled or not. Any non-durable or auto-deleting queues will be recovered unless they are explicitly deleted via Channel.queueDelete(String).
  
  Specified by:
  
  withQueueRecovery in interface ChannelConfig
- withUseDaemonThreads
  
  public Config withUseDaemonThreads(boolean enabled)
  
  Description copied from interface: ConnectionConfig
  
  Whether or not using daemon threads. Default is false.
  
  Specified by:
  
  withUseDaemonThreads in interface ConnectionConfig
- withRecoveryPolicy
  
  public Config withRecoveryPolicy(RecoveryPolicy recoveryPolicy)
  
  Sets the policy to use for the recovery of Connections/Channels/Consumers after an unexpected Connection/Channel closure. Can be overridden with specific policies via withConnectionRecoveryPolicy(RecoveryPolicy) and withChannelRecoveryPolicy(RecoveryPolicy).
- withRetryPolicy
  
  public Config withRetryPolicy(RetryPolicy retryPolicy)
  
  Sets the policy to use for handling connection attempt, Connection invocation, and Channel invocation errors. Can be overridden with specific policies via withConnectRetryPolicy(RetryPolicy), withConnectionRetryPolicy(RetryPolicy), and withChannelRetryPolicy(RetryPolicy).

Constructor	Description
`Config()`
`Config(Config parent)`	Creates a new Config object that inherits configuration from the `parent`.

Class Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details