Class AMQPFederationConsumerControlType

java.lang.Object

javax.management.StandardMBean

org.apache.activemq.artemis.core.management.impl.AbstractControl

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

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, AMQPFederationConsumerControl

public class AMQPFederationConsumerControlType
extends org.apache.activemq.artemis.core.management.impl.AbstractControl
implements AMQPFederationConsumerControl

Management object used for AMQP federation address and queue consumers to expose consumer state.

Field Summary

Fields inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl

storageManager

Constructor Summary

Constructors

Constructor	Description
AMQPFederationConsumerControlType(AMQPFederationConsumer consumer)

Method Summary

Modifier and Type	Method	Description
protected MBeanAttributeInfo[]	fillMBeanAttributeInfo()
protected MBeanOperationInfo[]	fillMBeanOperationInfo()
String	getAddress()	Gets the address that will be used for this federation consumer instance.
String	getFilterString()	Gets the filter string that will be used when creating the remote consumer.
String	getFqqn()	Gets the FQQN that comprises the address and queue where the remote consumer will be attached.
long	getMessagesReceived()	Returns the number of messages this federation consumer has received from the remote.
int	getPriority()	Gets the priority value that will be requested for the remote consumer that is created.
String	getQueueName()	Gets the queue name that will be used for this federation consumer instance.
String	getRole()	Returns the type of federation consumer being represented.
String	getRoutingType()	Gets the routing type that will be requested when creating a consumer on the remote server.

Methods inherited from class org.apache.activemq.artemis.core.management.impl.AbstractControl

blockOnIO, clearIO, getMBeanInfo, sendMessage, tcclCall, tcclInvoke

Methods inherited from class StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInterface, getParameterName, getParameterName, invoke, postDeregister, postRegister, preDeregister, preRegister, setAttribute, setAttributes, setImplementation

Methods inherited from class Object

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

Constructor Details

AMQPFederationConsumerControlType

public AMQPFederationConsumerControlType(AMQPFederationConsumer consumer)
                                  throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Details

getMessagesReceived

public long getMessagesReceived()

Description copied from interface: AMQPFederationConsumerControl

Returns the number of messages this federation consumer has received from the remote.

Specified by:

getMessagesReceived in interface AMQPFederationConsumerControl

Returns:

the number of messages this federation consumer has received from the remote

getRole

public String getRole()

Description copied from interface: AMQPFederationConsumerControl

Returns the type of federation consumer being represented.

Specified by:

getRole in interface AMQPFederationConsumerControl

Returns:

the type of federation consumer being represented

getQueueName

public String getQueueName()

Description copied from interface: AMQPFederationConsumerControl

Gets the queue name that will be used for this federation consumer instance.

For Queue federation this will be the name of the queue whose messages are being federated to this server instance. For an Address federation this will be an automatically generated name that should be unique to a given federation instance

Specified by:

getQueueName in interface AMQPFederationConsumerControl

Returns:

the queue name associated with the federation consumer

getAddress

public String getAddress()

Description copied from interface: AMQPFederationConsumerControl

Gets the address that will be used for this federation consumer instance.

For Queue federation this is the address under which the matching queue must reside. For Address federation this is the actual address whose messages are being federated.

Specified by:

getAddress in interface AMQPFederationConsumerControl

Returns:

the address associated with this federation consumer

getFqqn

public String getFqqn()

Description copied from interface: AMQPFederationConsumerControl

Gets the FQQN that comprises the address and queue where the remote consumer will be attached.

Specified by:

getFqqn in interface AMQPFederationConsumerControl

Returns:

provides the FQQN that can be used to address the consumer queue directly

getRoutingType

public String getRoutingType()

Description copied from interface: AMQPFederationConsumerControl

Gets the routing type that will be requested when creating a consumer on the remote server.

Specified by:

getRoutingType in interface AMQPFederationConsumerControl

Returns:

the routing type of the remote consumer

getFilterString

public String getFilterString()

Description copied from interface: AMQPFederationConsumerControl

Gets the filter string that will be used when creating the remote consumer.

For Queue federation this will be the filter that exists on the local queue that is requesting federation of messages from the remote. For address federation this filter will be used to restrict some movement of messages amongst federated server addresses.

Specified by:

getFilterString in interface AMQPFederationConsumerControl

Returns:

the filter string in use for the federation consumer

getPriority

public int getPriority()

Description copied from interface: AMQPFederationConsumerControl

Gets the priority value that will be requested for the remote consumer that is created.

Specified by:

getPriority in interface AMQPFederationConsumerControl

Returns:

the assigned consumer priority for the federation consumer

fillMBeanOperationInfo

protected MBeanOperationInfo[] fillMBeanOperationInfo()

Specified by:

fillMBeanOperationInfo in class org.apache.activemq.artemis.core.management.impl.AbstractControl

fillMBeanAttributeInfo

protected MBeanAttributeInfo[] fillMBeanAttributeInfo()

Specified by:

fillMBeanAttributeInfo in class org.apache.activemq.artemis.core.management.impl.AbstractControl