org.apache.james.queue.file

Class FileMailQueue

java.lang.Object

org.apache.james.queue.file.FileMailQueue

All Implemented Interfaces:

MailQueue, ManageableMailQueue

public class FileMailQueue
extends Object
implements ManageableMailQueue

ManageableMailQueue implementation which use the fs to store Mail's On create of the FileMailQueue the init() will get called. This takes care of load the needed meta-data into memory for fast access.

Nested Class Summary

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

ManageableMailQueue.MailQueueItemView, ManageableMailQueue.MailQueueIterator, 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

Constructor Summary

Constructors

Constructor and Description
FileMailQueue(File parentDir, String queuename, boolean sync, org.slf4j.Logger log)

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
MailQueue.MailQueueItem	deQueue() Dequeue the next ready-to-process Mail of the queue.
void	enQueue(org.apache.mailet.Mail mail) Enqueue the Mail to the queue
void	enQueue(org.apache.mailet.Mail mail, long delay, TimeUnit unit) Enqueue the Mail to 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) TODO: implement me

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMailQueue

public FileMailQueue(File parentDir,
             String queuename,
             boolean sync,
             org.slf4j.Logger log)
              throws IOException

Throws:

IOException

Method Detail

enQueue

public void enQueue(org.apache.mailet.Mail mail,
           long delay,
           TimeUnit unit)
             throws MailQueue.MailQueueException

Description copied from interface: MailQueue

Enqueue the Mail to the queue. The given delay and unit are used to calculate the time when the Mail will be available for deQueue

Specified by:

enQueue in interface MailQueue

Throws:

MailQueue.MailQueueException

enQueue

public void enQueue(org.apache.mailet.Mail mail)
             throws MailQueue.MailQueueException

Description copied from interface: MailQueue

Enqueue the Mail to the queue

Specified by:

enQueue in interface MailQueue

Throws:

MailQueue.MailQueueException

deQueue

public MailQueue.MailQueueItem deQueue()
                                throws MailQueue.MailQueueException

Description copied from interface: MailQueue

Dequeue the next ready-to-process Mail of the queue. This method will block until a Mail is ready and then process the operation. Implementations should take care todo some kind of transactions to not loose any mail on error

Specified by:

deQueue in interface MailQueue

Throws:

MailQueue.MailQueueException

getSize

public long getSize()
             throws MailQueue.MailQueueException

Description copied from interface: ManageableMailQueue

Return the size of the queue

Specified by:

getSize in interface ManageableMailQueue

Returns:

size

Throws:

MailQueue.MailQueueException

flush

public long flush()
           throws MailQueue.MailQueueException

Description copied from interface: ManageableMailQueue

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

Specified by:

flush in interface ManageableMailQueue

Returns:

count the count of all flushed mails

Throws:

MailQueue.MailQueueException

clear

public long clear()
           throws MailQueue.MailQueueException

Description copied from interface: ManageableMailQueue

Remove all mails from the queue

Specified by:

clear in interface ManageableMailQueue

Returns:

count the count of all removed mails

Throws:

MailQueue.MailQueueException

remove

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

TODO: implement me

Specified by:

remove in interface ManageableMailQueue

Returns:

count the count of all removed mails

Throws:

MailQueue.MailQueueException

See Also:

ManageableMailQueue.remove(org.apache.james.queue.api.ManageableMailQueue.Type, String)

browse

public ManageableMailQueue.MailQueueIterator browse()
                                             throws MailQueue.MailQueueException

Description copied from interface: ManageableMailQueue

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

Specified by:

browse in interface ManageableMailQueue

Returns:

content

Throws:

MailQueue.MailQueueException