org.vatplanner.commons.amqp

Class ExchangeParameters

java.lang.Object

org.vatplanner.commons.amqp.ExchangeParameters

public class ExchangeParameters
extends Object

Holds and provides a ExchangeParameters.Builder for the parameters of AMQP exchanges as commonly used throughout VATPlanner configuration Properties.

Configuration keys are expected to start with followed by an exchange-specific key part and ending in , , , and . If any of the keys are left unconfigured, the configured ExchangeParameters.Builder defaults will be applied instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExchangeParameters.Builder Builds ExchangeParameters from Properties, falling back to configurable default values for undefined parameters.

Method Summary

Modifier and Type	Method and Description
static ExchangeParameters.Builder	builder() Returns a new ExchangeParameters.Builder to construct ExchangeParameters.
String	getDefaultRoutingKey() Returns the routing key that should be used to bind queues to the exchange unless implementation has specific requirements to use different keys.
String	getName() Returns the name of the AMQP exchange.
String	getType() Returns what type the exchange should be when being declared.
boolean	isDurable() Indicates whether the exchange should be declared durable.
boolean	shouldDeclare() Indicates whether the exchange should be declared on AMQP.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns the name of the AMQP exchange.

Returns:

exchange name

shouldDeclare

public boolean shouldDeclare()

Indicates whether the exchange should be declared on AMQP. A "passive declaration" (check for existence) should usually still be performed even if the exchange should not be "actively" declared (redefined).

Returns:

true if the exchange should be declared, false if not (check only)

getDefaultRoutingKey

public String getDefaultRoutingKey()

Returns the routing key that should be used to bind queues to the exchange unless implementation has specific requirements to use different keys.

Returns:

routing key to bind queues to the exchange unless specific requirements exist

isDurable

public boolean isDurable()

Indicates whether the exchange should be declared durable.

Returns:

true if the exchange should be durable, false if not

getType

public String getType()

Returns what type the exchange should be when being declared.

Returns:

exchange type

toString

public String toString()

Overrides:

toString in class Object

builder

public static ExchangeParameters.Builder builder()

Returns a new ExchangeParameters.Builder to construct ExchangeParameters.

Returns:

new ExchangeParameters.Builder instance