org.apache.james.queue.api

Interface ManageableMailQueue

All Superinterfaces:

MailQueue

All Known Implementing Classes:

ActiveMQMailQueue, FileMailQueue, JMSMailQueue

public interface ManageableMailQueue
extends MailQueue

MailQueue which is manageable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ManageableMailQueue.MailQueueItemView Represent a View over a queue MailQueue.MailQueueItem
static interface	ManageableMailQueue.MailQueueIterator Iterator subclass which allows to browse the content of a queue.
static class	ManageableMailQueue.Type

Nested classes/interfaces inherited from interface org.apache.james.queue.api.MailQueue

MailQueue.MailQueueException, MailQueue.MailQueueItem

Field Summary

Fields inherited from interface org.apache.james.queue.api.MailQueue

NO_DELAY

Method Summary

Methods

Modifier and Type	Method and Description
ManageableMailQueue.MailQueueIterator	browse() Allow to browse the queues content.
long	clear() Remove all mails from the queue
long	flush() Flush the queue, which means it will make all message ready for dequeue
long	getSize() Return the size of the queue
long	remove(ManageableMailQueue.Type type, String value) Remove all mails from the queue that match

Methods inherited from interface org.apache.james.queue.api.MailQueue

deQueue, enQueue, enQueue

Method Detail

getSize

long getSize()
             throws MailQueue.MailQueueException

Return the size of the queue

Returns:

size

Throws:

MailQueueException

MailQueue.MailQueueException

flush

long flush()
           throws MailQueue.MailQueueException

Flush the queue, which means it will make all message ready for dequeue

Returns:

count the count of all flushed mails

Throws:

MailQueueException

MailQueue.MailQueueException

clear

long clear()
           throws MailQueue.MailQueueException

Remove all mails from the queue

Returns:

count the count of all removed mails

Throws:

MailQueueException

MailQueue.MailQueueException

remove

long remove(ManageableMailQueue.Type type,
          String value)
            throws MailQueue.MailQueueException

Remove all mails from the queue that match

Parameters:

type -

value -

Returns:

count the count of all removed mails

Throws:

MailQueueException

MailQueue.MailQueueException

browse

ManageableMailQueue.MailQueueIterator browse()
                                             throws MailQueue.MailQueueException

Allow to browse the queues content. The returned content may get modified while browsing it during other threads.

Returns:

content

Throws:

MailQueue.MailQueueException