Package org.apache.activemq.artemis.protocol.amqp.connect.federation

Class AMQPFederation

java.lang.Object

org.apache.activemq.artemis.protocol.amqp.connect.federation.AMQPFederation

All Implemented Interfaces:

Federation, FederationInternal

Direct Known Subclasses:

AMQPFederationSource, AMQPFederationTarget

public abstract class AMQPFederation
extends Object
implements FederationInternal

A single AMQP Federation instance that can be tied to an AMQP broker connection or used on a remote peer to control the reverse case of when the remote configures the target side of the connection.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,FederationAddressPolicyManager>	addressMatchPolicies
protected boolean	connected
protected AMQPConnectionContext	connection
protected AMQPFederationEventDispatcher	eventDispatcher
protected AMQPFederationEventProcessor	eventProcessor
static String	FEDERATION_INSTANCE_RECORD	Value used to store the federation instance used by an AMQP connection that is performing remote command and control operations or is the target of said operations.
protected Map<String,Predicate<org.apache.qpid.proton.engine.Link>>	linkClosedinterceptors
protected String	name
protected Map<String,FederationQueuePolicyManager>	queueMatchPolicies
protected ScheduledExecutorService	scheduler
protected org.apache.activemq.artemis.core.server.ActiveMQServer	server
protected AMQPSessionContext	session
protected boolean	started
protected WildcardConfiguration	wildcardConfiguration

Constructor Summary

Constructors

Constructor	Description
AMQPFederation(String name, org.apache.activemq.artemis.core.server.ActiveMQServer server)

Method Summary

Modifier and Type	Method	Description
AMQPFederation	addAddressMatchPolicy(FederationReceiveFromAddressPolicy addressPolicy)	Adds a new FederationReceiveFromAddressPolicy entry to the set of policies that this federation will use to create demand on the remote when local demand is present.
AMQPFederation	addLinkClosedInterceptor(String id, Predicate<org.apache.qpid.proton.engine.Link> interceptor)	Adds a remote linked closed event interceptor that can intercept the closed event and if it returns true indicate that the close has been handled and that no further action need to be taken for this event.
AMQPFederation	addQueueMatchPolicy(FederationReceiveFromQueuePolicy queuePolicy)	Adds a new FederationReceiveFromQueuePolicy entry to the set of policies that this federation will use to create demand on the remote when local demand is present.
abstract AMQPConnectionContext	getConnectionContext()
abstract int	getLargeMessageThreshold()
abstract int	getLinkAttachTimeout()
String	getName()
abstract int	getReceiverCredits()
abstract int	getReceiverCreditsLow()
ScheduledExecutorService	getScheduler()
org.apache.activemq.artemis.core.server.ActiveMQServer	getServer()
abstract AMQPSessionContext	getSessionContext()
WildcardConfiguration	getWildcardConfiguration()
protected void	handleFederationStarted()	Provides an entry point for the concrete federation implementation to respond to being started.
protected void	handleFederationStopped()	Provides an entry point for the concrete federation implementation to respond to being stopped.
protected boolean	invokeLinkClosedInterceptors(org.apache.qpid.proton.engine.Link link)
abstract boolean	isCoreMessageTunnelingEnabled()
abstract boolean	isIgnoreQueueConsumerFilters()
abstract boolean	isIgnoreQueueConsumerPriorities()
boolean	isStarted()
AMQPFederation	removeLinkClosedInterceptor(String id)	Remove a previously registered link close interceptor from the list of close interceptor bindings.
protected abstract void	signalError(Exception cause)	Error signaling API that must be implemented by the specific federation implementation to handle errors encountered during normal operations.
protected void	signalFederationStarted()
protected void	signalFederationStopped()
protected abstract void	signalResourceCreateError(Exception cause)	Error signaling API that must be implemented by the specific federation implementation to handle error when creating a federation resource such as an outgoing receiver link.
void	start()	Start the federation instance if not already started.
void	stop()	Stop the federation instance if not already stopped.

Methods inherited from class java.lang.Object

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

Field Detail

FEDERATION_INSTANCE_RECORD

public static final String FEDERATION_INSTANCE_RECORD

Value used to store the federation instance used by an AMQP connection that is performing remote command and control operations or is the target of said operations. Only one federation instance is allowed per connection and will be checked.

See Also:

Constant Field Values

queueMatchPolicies

protected final Map<String,FederationQueuePolicyManager> queueMatchPolicies

addressMatchPolicies

protected final Map<String,FederationAddressPolicyManager> addressMatchPolicies

linkClosedinterceptors

protected final Map<String,Predicate<org.apache.qpid.proton.engine.Link>> linkClosedinterceptors

wildcardConfiguration

protected final WildcardConfiguration wildcardConfiguration

scheduler

protected final ScheduledExecutorService scheduler

name

protected final String name

server

protected final org.apache.activemq.artemis.core.server.ActiveMQServer server

eventDispatcher

protected AMQPFederationEventDispatcher eventDispatcher

eventProcessor

protected AMQPFederationEventProcessor eventProcessor

connection

protected volatile AMQPConnectionContext connection

session

protected volatile AMQPSessionContext session

started

protected boolean started

connected

protected volatile boolean connected

Constructor Detail

AMQPFederation

public AMQPFederation(String name,
                      org.apache.activemq.artemis.core.server.ActiveMQServer server)

Method Detail

getWildcardConfiguration

public WildcardConfiguration getWildcardConfiguration()

Returns:

the WildcardConfiguration that is in use by this server federation.

getScheduler

public ScheduledExecutorService getScheduler()

getServer

public org.apache.activemq.artemis.core.server.ActiveMQServer getServer()

Specified by:

getServer in interface Federation

Returns:

the ActiveMQServer instance assigned to this Federation

getName

public String getName()

Specified by:

getName in interface Federation

Returns:

the unique name that was assigned to this server federation connector.

isStarted

public boolean isStarted()

Specified by:

isStarted in interface Federation

Returns:

is this federation instance started (may not be connected yet).

getConnectionContext

public abstract AMQPConnectionContext getConnectionContext()

Returns:

the session context assigned to this federation instance

getSessionContext

public abstract AMQPSessionContext getSessionContext()

Returns:

the session context assigned to this federation instance

getLinkAttachTimeout

public abstract int getLinkAttachTimeout()

Returns:

the timeout before signaling an error when creating remote link (0 mean disable).

getReceiverCredits

public abstract int getReceiverCredits()

Returns:

the configured Receiver link credit batch size.

getReceiverCreditsLow

public abstract int getReceiverCreditsLow()

Returns:

the configured Receiver link credit low value.

getLargeMessageThreshold

public abstract int getLargeMessageThreshold()

Returns:

the size in bytes before a message is considered large.

isIgnoreQueueConsumerFilters

public abstract boolean isIgnoreQueueConsumerFilters()

Returns:

the true if the federation should ignore filters on queue consumers.

isIgnoreQueueConsumerPriorities

public abstract boolean isIgnoreQueueConsumerPriorities()

Returns:

the true if the federation should ignore priorities on queue consumers.

isCoreMessageTunnelingEnabled

public abstract boolean isCoreMessageTunnelingEnabled()

Returns:

the true if the federation should support core message tunneling.

start

public final void start()
                 throws ActiveMQException

Description copied from interface: FederationInternal

Start the federation instance if not already started.

Specified by:

start in interface FederationInternal

Throws:

ActiveMQException - if an error occurs during the start.

stop

public final void stop()
                throws ActiveMQException

Description copied from interface: FederationInternal

Stop the federation instance if not already stopped.

Specified by:

stop in interface FederationInternal

Throws:

ActiveMQException - if an error occurs during the stop.

addLinkClosedInterceptor

public AMQPFederation addLinkClosedInterceptor(String id,
                                               Predicate<org.apache.qpid.proton.engine.Link> interceptor)

Adds a remote linked closed event interceptor that can intercept the closed event and if it returns true indicate that the close has been handled and that no further action need to be taken for this event.

Parameters:

id - A unique Id value that identifies the interceptor for later removal.

interceptor - The predicate that will be called for any link close.

Returns:

this AMQPFederation instance.

removeLinkClosedInterceptor

public AMQPFederation removeLinkClosedInterceptor(String id)

Remove a previously registered link close interceptor from the list of close interceptor bindings.

Parameters:

id - The id of the interceptor to remove

Returns:

this AMQPFederation instance.

addQueueMatchPolicy

public AMQPFederation addQueueMatchPolicy(FederationReceiveFromQueuePolicy queuePolicy)
                                   throws ActiveMQException

Adds a new FederationReceiveFromQueuePolicy entry to the set of policies that this federation will use to create demand on the remote when local demand is present.

Parameters:

queuePolicy - The policy to add to the set of configured FederationReceiveFromQueuePolicy instance.

Returns:

this AMQPFederation instance.

Throws:

ActiveMQException - if an error occurs processing the added policy

addAddressMatchPolicy

public AMQPFederation addAddressMatchPolicy(FederationReceiveFromAddressPolicy addressPolicy)
                                     throws ActiveMQException

Adds a new FederationReceiveFromAddressPolicy entry to the set of policies that this federation will use to create demand on the remote when local demand is present.

Parameters:

addressPolicy - The policy to add to the set of configured FederationReceiveFromAddressPolicy instance.

Returns:

this AMQPFederation instance.

Throws:

ActiveMQException - if an error occurs processing the added policy

signalResourceCreateError

protected abstract void signalResourceCreateError(Exception cause)

Error signaling API that must be implemented by the specific federation implementation to handle error when creating a federation resource such as an outgoing receiver link.

Parameters:

cause - The error that caused the resource creation to fail.

signalError

protected abstract void signalError(Exception cause)

Error signaling API that must be implemented by the specific federation implementation to handle errors encountered during normal operations.

Parameters:

cause - The error that caused the operation to fail.

handleFederationStarted

protected void handleFederationStarted()
                                throws ActiveMQException

Provides an entry point for the concrete federation implementation to respond to being started.

Throws:

ActiveMQException - if an error is thrown during policy start.

handleFederationStopped

protected void handleFederationStopped()
                                throws ActiveMQException

Provides an entry point for the concrete federation implementation to respond to being stopped.

Throws:

ActiveMQException - if an error is thrown during policy stop.

invokeLinkClosedInterceptors

protected boolean invokeLinkClosedInterceptors(org.apache.qpid.proton.engine.Link link)

signalFederationStarted

protected void signalFederationStarted()

signalFederationStopped

protected void signalFederationStopped()