org.apache.james.queue.library

Class MailQueueManagement

java.lang.Object

javax.management.StandardMBean

org.apache.james.queue.library.MailQueueManagement

All Implemented Interfaces:

DynamicMBean, MBeanRegistration, MailQueueManagementMBean

public class MailQueueManagement
extends StandardMBean
implements MailQueueManagementMBean

JMX MBean implementation which expose management functions by wrapping a ManageableMailQueue

Constructor Summary

Constructors

Constructor and Description
MailQueueManagement(ManageableMailQueue queue)

Method Summary

Methods

Modifier and Type	Method and Description
List<CompositeData>	browse() Allow to browse the content of the queue
long	clear() Clear the queue
long	flush() Flush queue to make every Mail ready to consume.
long	getSize() Return the size of the queue or -1 if the size could not get calculated
long	removeWithName(String name) Remove mail with name from the queue
long	removeWithRecipient(String address) Remove mail with specific recipient from the queue
long	removeWithSender(String address) Remove mail with specific sender from the queue

Methods inherited from class javax.management.StandardMBean

cacheMBeanInfo, getAttribute, getAttributes, getCachedMBeanInfo, getClassName, getConstructors, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getDescription, getImpact, getImplementation, getImplementationClass, getMBeanInfo, 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

MailQueueManagement

public MailQueueManagement(ManageableMailQueue queue)
                    throws NotCompliantMBeanException

Throws:

NotCompliantMBeanException

Method Detail

clear

public long clear()
           throws Exception

Description copied from interface: MailQueueManagementMBean

Clear the queue

Specified by:

clear in interface MailQueueManagementMBean

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

See Also:

MailQueueManagementMBean.clear()

flush

public long flush()
           throws Exception

Description copied from interface: MailQueueManagementMBean

Flush queue to make every Mail ready to consume.

Specified by:

flush in interface MailQueueManagementMBean

Returns:

count the count of all flushed mails or -1 if the flush was not possible

Throws:

Exception

See Also:

MailQueueManagementMBean.flush()

getSize

public long getSize()
             throws Exception

Description copied from interface: MailQueueManagementMBean

Return the size of the queue or -1 if the size could not get calculated

Specified by:

getSize in interface MailQueueManagementMBean

Returns:

size the size or -1 if it could not get calculated

Throws:

Exception

See Also:

MailQueueManagementMBean.getSize()

removeWithName

public long removeWithName(String name)
                    throws Exception

Description copied from interface: MailQueueManagementMBean

Remove mail with name from the queue

Specified by:

removeWithName in interface MailQueueManagementMBean

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

See Also:

MailQueueManagementMBean.removeWithName(java.lang.String)

removeWithRecipient

public long removeWithRecipient(String address)
                         throws Exception

Description copied from interface: MailQueueManagementMBean

Remove mail with specific recipient from the queue

Specified by:

removeWithRecipient in interface MailQueueManagementMBean

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

See Also:

(java.lang.String)

removeWithSender

public long removeWithSender(String address)
                      throws Exception

Description copied from interface: MailQueueManagementMBean

Remove mail with specific sender from the queue

Specified by:

removeWithSender in interface MailQueueManagementMBean

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

See Also:

MailQueueManagementMBean.removeWithSender(java.lang.String)

browse

public List<CompositeData> browse()
                           throws Exception

Description copied from interface: MailQueueManagementMBean

Allow to browse the content of the queue

Specified by:

browse in interface MailQueueManagementMBean

Returns:

data

Throws:

Exception

See Also:

MailQueueManagementMBean.browse()