Package org.springframework.amqp.core

Class AbstractExchange

java.lang.Object

org.springframework.amqp.core.AbstractDeclarable

org.springframework.amqp.core.AbstractExchange

All Implemented Interfaces:

Declarable, Exchange

Direct Known Subclasses:

CustomExchange, DirectExchange, FanoutExchange, HeadersExchange, TopicExchange

public abstract class AbstractExchange
extends AbstractDeclarable
implements Exchange

Common properties that describe all exchange types.

Subclasses of this class are typically used with administrative operations that declare an exchange.

Author:

Mark Pollack, Gary Russell, Artem Bilan

See Also:

AmqpAdmin

Constructor Summary

Constructors

Constructor	Description
AbstractExchange(java.lang.String name)	Construct a new durable, non-auto-delete Exchange with the provided name.
AbstractExchange(java.lang.String name, boolean durable, boolean autoDelete)	Construct a new Exchange, given a name, durability flag, auto-delete flag.
AbstractExchange(java.lang.String name, boolean durable, boolean autoDelete, java.util.Map<java.lang.String,java.lang.Object> arguments)	Construct a new Exchange, given a name, durability flag, and auto-delete flag, and arguments.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()	The name of the exchange.
abstract java.lang.String	getType()	The type of the exchange.
boolean	isAutoDelete()	True if the server should delete the exchange when it is no longer in use (if all bindings are deleted).
boolean	isDelayed()	Is a delayed message exchange; currently requires a broker plugin.
boolean	isDurable()	A durable exchange will survive a server restart.
boolean	isInternal()	Is an exchange internal; i.e.
void	setDelayed(boolean delayed)	Set the delayed flag.
void	setInternal(boolean internal)	Set the internal flag.
java.lang.String	toString()

Methods inherited from class org.springframework.amqp.core.AbstractDeclarable

addArgument, getArguments, getDeclaringAdmins, isIgnoreDeclarationExceptions, removeArgument, setAdminsThatShouldDeclare, setIgnoreDeclarationExceptions, setShouldDeclare, shouldDeclare

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.amqp.core.Declarable

addArgument, getDeclaringAdmins, isIgnoreDeclarationExceptions, removeArgument, setAdminsThatShouldDeclare, shouldDeclare

Methods inherited from interface org.springframework.amqp.core.Exchange

getArguments

Constructor Detail

AbstractExchange

public AbstractExchange(java.lang.String name)

Construct a new durable, non-auto-delete Exchange with the provided name.

Parameters:

name - the name of the exchange.

AbstractExchange

public AbstractExchange(java.lang.String name,
                        boolean durable,
                        boolean autoDelete)

Construct a new Exchange, given a name, durability flag, auto-delete flag.

Parameters:

name - the name of the exchange.

durable - true if we are declaring a durable exchange (the exchange will survive a server restart)

autoDelete - true if the server should delete the exchange when it is no longer in use

AbstractExchange

public AbstractExchange(java.lang.String name,
                        boolean durable,
                        boolean autoDelete,
                        java.util.Map<java.lang.String,java.lang.Object> arguments)

Construct a new Exchange, given a name, durability flag, and auto-delete flag, and arguments.

Parameters:

name - the name of the exchange.

durable - true if we are declaring a durable exchange (the exchange will survive a server restart)

autoDelete - true if the server should delete the exchange when it is no longer in use

arguments - the arguments used to declare the exchange

Method Detail

getType

public abstract java.lang.String getType()

Description copied from interface: Exchange

The type of the exchange. See ExchangeTypes for some well-known examples.

Specified by:

getType in interface Exchange

Returns:

the type of the exchange.

getName

public java.lang.String getName()

Description copied from interface: Exchange

The name of the exchange.

Specified by:

getName in interface Exchange

Returns:

the name of the exchange.

isDurable

public boolean isDurable()

Description copied from interface: Exchange

A durable exchange will survive a server restart.

Specified by:

isDurable in interface Exchange

Returns:

true if durable.

isAutoDelete

public boolean isAutoDelete()

Description copied from interface: Exchange

True if the server should delete the exchange when it is no longer in use (if all bindings are deleted).

Specified by:

isAutoDelete in interface Exchange

Returns:

true if auto-delete.

isDelayed

public boolean isDelayed()

Description copied from interface: Exchange

Is a delayed message exchange; currently requires a broker plugin.

Specified by:

isDelayed in interface Exchange

Returns:

true if delayed.

setDelayed

public void setDelayed(boolean delayed)

Set the delayed flag.

Parameters:

delayed - the delayed.

Since:

1.6

See Also:

Exchange.isDelayed()

isInternal

public boolean isInternal()

Description copied from interface: Exchange

Is an exchange internal; i.e. can't be directly published to by a client, used for exchange-to-exchange binding only.

Specified by:

isInternal in interface Exchange

Returns:

true if internal.

setInternal

public void setInternal(boolean internal)

Set the internal flag.

Parameters:

internal - the internal.

Since:

1.6

See Also:

Exchange.isInternal()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object