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

Class AddressControlImpl

java.lang.Object

javax.management.StandardMBean

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

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

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, AddressControl

public class AddressControlImpl
extends AbstractControl
implements AddressControl

Field Summary

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

storageManager

Fields inherited from interface org.apache.activemq.artemis.api.core.management.AddressControl

ADDRESS_SIZE_DESCRIPTION, NUMBER_OF_PAGES_DESCRIPTION, ROUTED_MESSAGE_COUNT_DESCRIPTION, UNROUTED_MESSAGE_COUNT_DESCRIPTION

Constructor Summary

Constructors

Constructor	Description
AddressControlImpl(AddressInfo addressInfo, ActiveMQServer server, PagingManager pagingManager, StorageManager storageManager, HierarchicalRepository<Set<Role>> securityRepository, SecurityStore securityStore, ManagementService managementService)

Method Summary

Modifier and Type	Method	Description
boolean	block()	Blocks message production to this address by limiting credit
boolean	clearDuplicateIdCache()
protected MBeanAttributeInfo[]	fillMBeanAttributeInfo()
protected MBeanOperationInfo[]	fillMBeanOperationInfo()
String	getAddress()	Returns the managed address.
int	getAddressLimitPercent()	Returns the % of memory limit that is currently in use
long	getAddressSize()	Returns the number of estimated bytes being used by all the queue(s) bound to this address; used to control paging and blocking.
String[]	getAllQueueNames()	Returns the names of both the local and remote queue(s) bound to this address.
String[]	getBindingNames()	Returns the names of all bindings (both queues and diverts) bound to this address
long	getCurrentDuplicateIdCacheSize()
long	getMessageCount()
long	getNumberOfBytesPerPage()	Returns the number of bytes used by each page for this address.
long	getNumberOfMessages()	Deprecated.
int	getNumberOfPages()	Returns the number of pages used by this address.
String[]	getQueueNames()	Returns the names of the local queue(s) bound to this address.
String[]	getRemoteQueueNames()	Returns the names of the remote queue(s) bound to this address.
Object[]	getRoles()	Returns the roles (name and permissions) associated with this address.
String	getRolesAsJSON()	Returns the roles (name and permissions) associated with this address using JSON serialization.
long	getRoutedMessageCount()	Returns the number of messages routed to one or more bindings
String[]	getRoutingTypes()
String	getRoutingTypesAsJSON()
long	getUnRoutedMessageCount()	Returns the number of messages not routed to any bindings
boolean	isAutoCreated()	Returns whether this address was created automatically in response to client action.
boolean	isInternal()	Returns whether this address was created for the broker's internal use.
boolean	isPaging()	Returns whether this address is paging.
boolean	isPaused()
boolean	isRetroactiveResource()
boolean	isTemporary()	Returns whether this address is temporary.
void	pause()	Pauses all the queues bound to this address.
void	pause(boolean persist)	Pauses all the queues bound to this address.
long	purge()	Purge all the queues bound of this address.
void	replay(String target, String filter)
void	replay(String startScan, String endScan, String target, String filter)
void	resume()	Resume all the queues bound of this address.
String	sendMessage(Map<String,String> headers, int type, String body, boolean durable, String user, String password)
String	sendMessage(Map<String,String> headers, int type, String body, boolean durable, String user, String password, boolean createMessageId)
void	unblock()

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

blockOnIO, clearIO, getMBeanInfo, sendMessage, tcclCall, tcclInvoke

Methods inherited from class javax.management.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 java.lang.Object

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

Constructor Detail

AddressControlImpl

public AddressControlImpl(AddressInfo addressInfo,
                          ActiveMQServer server,
                          PagingManager pagingManager,
                          StorageManager storageManager,
                          HierarchicalRepository<Set<Role>> securityRepository,
                          SecurityStore securityStore,
                          ManagementService managementService)
                   throws Exception

Throws:

Exception

Method Detail

getAddress

public String getAddress()

Description copied from interface: AddressControl

Returns the managed address.

Specified by:

getAddress in interface AddressControl

getRoutingTypes

public String[] getRoutingTypes()

Specified by:

getRoutingTypes in interface AddressControl

getRoutingTypesAsJSON

public String getRoutingTypesAsJSON()
                             throws Exception

Specified by:

getRoutingTypesAsJSON in interface AddressControl

Throws:

Exception

getRemoteQueueNames

public String[] getRemoteQueueNames()

Description copied from interface: AddressControl

Returns the names of the remote queue(s) bound to this address.

Specified by:

getRemoteQueueNames in interface AddressControl

getQueueNames

public String[] getQueueNames()

Description copied from interface: AddressControl

Returns the names of the local queue(s) bound to this address.

Specified by:

getQueueNames in interface AddressControl

getAllQueueNames

public String[] getAllQueueNames()

Description copied from interface: AddressControl

Returns the names of both the local and remote queue(s) bound to this address.

Specified by:

getAllQueueNames in interface AddressControl

getBindingNames

public String[] getBindingNames()
                         throws Exception

Description copied from interface: AddressControl

Returns the names of all bindings (both queues and diverts) bound to this address

Specified by:

getBindingNames in interface AddressControl

Throws:

Exception

getRoles

public Object[] getRoles()
                  throws Exception

Description copied from interface: AddressControl

Returns the roles (name and permissions) associated with this address.

Specified by:

getRoles in interface AddressControl

Throws:

Exception

getRolesAsJSON

public String getRolesAsJSON()
                      throws Exception

Description copied from interface: AddressControl

Returns the roles (name and permissions) associated with this address using JSON serialization.
Java objects can be recreated from JSON serialization using RoleInfo.from(String).

Specified by:

getRolesAsJSON in interface AddressControl

Throws:

Exception

getNumberOfBytesPerPage

public long getNumberOfBytesPerPage()
                             throws Exception

Description copied from interface: AddressControl

Returns the number of bytes used by each page for this address.

Specified by:

getNumberOfBytesPerPage in interface AddressControl

Throws:

Exception

getAddressSize

public long getAddressSize()

Description copied from interface: AddressControl

Returns the number of estimated bytes being used by all the queue(s) bound to this address; used to control paging and blocking.

Specified by:

getAddressSize in interface AddressControl

getNumberOfMessages

@Deprecated
public long getNumberOfMessages()

Deprecated.

Description copied from interface: AddressControl

Returns the sum of messages on queue(s), including messages in delivery.

Specified by:

getNumberOfMessages in interface AddressControl

isPaging

public boolean isPaging()
                 throws Exception

Description copied from interface: AddressControl

Returns whether this address is paging.

Specified by:

isPaging in interface AddressControl

Throws:

Exception

getAddressLimitPercent

public int getAddressLimitPercent()
                           throws Exception

Description copied from interface: AddressControl

Returns the % of memory limit that is currently in use

Specified by:

getAddressLimitPercent in interface AddressControl

Throws:

Exception

block

public boolean block()

Description copied from interface: AddressControl

Blocks message production to this address by limiting credit

Specified by:

block in interface AddressControl

Returns:

true if production is blocked

unblock

public void unblock()

Specified by:

unblock in interface AddressControl

getNumberOfPages

public int getNumberOfPages()

Description copied from interface: AddressControl

Returns the number of pages used by this address.

Specified by:

getNumberOfPages in interface AddressControl

getMessageCount

public long getMessageCount()

Specified by:

getMessageCount in interface AddressControl

getRoutedMessageCount

public long getRoutedMessageCount()

Description copied from interface: AddressControl

Returns the number of messages routed to one or more bindings

Specified by:

getRoutedMessageCount in interface AddressControl

getUnRoutedMessageCount

public long getUnRoutedMessageCount()

Description copied from interface: AddressControl

Returns the number of messages not routed to any bindings

Specified by:

getUnRoutedMessageCount in interface AddressControl

sendMessage

public String sendMessage(Map<String,String> headers,
                          int type,
                          String body,
                          boolean durable,
                          String user,
                          String password)
                   throws Exception

Specified by:

sendMessage in interface AddressControl

Parameters:

headers - the message headers and properties to set. Can only container Strings maped to primitive types.

body - the text to send

Returns:

Throws:

Exception

sendMessage

public String sendMessage(Map<String,String> headers,
                          int type,
                          String body,
                          boolean durable,
                          String user,
                          String password,
                          boolean createMessageId)
                   throws Exception

Specified by:

sendMessage in interface AddressControl

Parameters:

headers - the message headers and properties to set. Can only container Strings maped to primitive types.

body - the text to send

createMessageId - whether or not to auto generate a Message ID

Returns:

Throws:

Exception

fillMBeanOperationInfo

protected MBeanOperationInfo[] fillMBeanOperationInfo()

Specified by:

fillMBeanOperationInfo in class AbstractControl

fillMBeanAttributeInfo

protected MBeanAttributeInfo[] fillMBeanAttributeInfo()

Specified by:

fillMBeanAttributeInfo in class AbstractControl

pause

public void pause()

Description copied from interface: AddressControl

Pauses all the queues bound to this address. Messages are no longer delivered to all its bounded queues. Newly added queue will be paused too until resume is called.

Specified by:

pause in interface AddressControl

pause

public void pause(boolean persist)

Description copied from interface: AddressControl

Pauses all the queues bound to this address. Messages are no longer delivered to all its bounded queues. Newly added queue will be paused too until resume is called.

Specified by:

pause in interface AddressControl

Parameters:

persist - if true, the pause state will be persisted.

resume

public void resume()

Description copied from interface: AddressControl

Resume all the queues bound of this address. Messages are delivered again to all its bounded queues.

Specified by:

resume in interface AddressControl

isPaused

public boolean isPaused()

Specified by:

isPaused in interface AddressControl

isRetroactiveResource

public boolean isRetroactiveResource()

Specified by:

isRetroactiveResource in interface AddressControl

getCurrentDuplicateIdCacheSize

public long getCurrentDuplicateIdCacheSize()

Specified by:

getCurrentDuplicateIdCacheSize in interface AddressControl

clearDuplicateIdCache

public boolean clearDuplicateIdCache()

Specified by:

clearDuplicateIdCache in interface AddressControl

isAutoCreated

public boolean isAutoCreated()

Description copied from interface: AddressControl

Returns whether this address was created automatically in response to client action.

Specified by:

isAutoCreated in interface AddressControl

isInternal

public boolean isInternal()

Description copied from interface: AddressControl

Returns whether this address was created for the broker's internal use.

Specified by:

isInternal in interface AddressControl

isTemporary

public boolean isTemporary()

Description copied from interface: AddressControl

Returns whether this address is temporary.

Specified by:

isTemporary in interface AddressControl

purge

public long purge()
           throws Exception

Description copied from interface: AddressControl

Purge all the queues bound of this address. Returns the total number of messages purged.

Specified by:

purge in interface AddressControl

Throws:

Exception

replay

public void replay(String target,
                   String filter)
            throws Exception

Specified by:

replay in interface AddressControl

Throws:

Exception

replay

public void replay(String startScan,
                   String endScan,
                   String target,
                   String filter)
            throws Exception

Specified by:

replay in interface AddressControl

Throws:

Exception