org.apache.james.mailrepository.file

Class FileMailRepository

java.lang.Object

org.apache.james.mailrepository.lib.AbstractMailRepository

org.apache.james.mailrepository.file.FileMailRepository

All Implemented Interfaces:

Configurable, LogEnabled, MailRepository

public class FileMailRepository
extends AbstractMailRepository

Implementation of a MailRepository on a FileSystem.

Requires a configuration element in the .conf.xml file of the form:

  <repository destinationURL="file://path-to-root-dir-for-repository"
              type="MAIL"
              model="SYNCHRONOUS"/>
 

Requires a logger called MailRepository.

Field Summary

Fields inherited from class org.apache.james.mailrepository.lib.AbstractMailRepository

DEEP_DEBUG

Constructor Summary

Constructors

Constructor and Description
FileMailRepository()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
void	init()
protected void	internalRemove(String key)
protected void	internalStore(org.apache.mailet.Mail mc)
Iterator	list() List string keys of messages in repository.
org.apache.mailet.Mail	retrieve(String key) Retrieves a message given a key.
void	setFileSystem(FileSystem fs)

Methods inherited from class org.apache.james.mailrepository.lib.AbstractMailRepository

configure, getLogger, lock, remove, remove, remove, setLog, store, unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMailRepository

public FileMailRepository()

Method Detail

setFileSystem

public void setFileSystem(FileSystem fs)

doConfigure

protected void doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
                    throws org.apache.commons.configuration.ConfigurationException

Overrides:

doConfigure in class AbstractMailRepository

Throws:

org.apache.commons.configuration.ConfigurationException

init

@PostConstruct
public void init()
          throws Exception

Throws:

Exception

internalStore

protected void internalStore(org.apache.mailet.Mail mc)
                      throws javax.mail.MessagingException,
                             IOException

Specified by:

internalStore in class AbstractMailRepository

Throws:

javax.mail.MessagingException

IOException

See Also:

AbstractMailRepository.internalStore(Mail)

retrieve

public org.apache.mailet.Mail retrieve(String key)
                                throws javax.mail.MessagingException

Description copied from interface: MailRepository

Retrieves a message given a key. At the moment, keys can be obtained from list() in superinterface Store.Repository

Parameters:

key - the key of the message to retrieve

Returns:

the mail corresponding to this key, null if none exists

Throws:

javax.mail.MessagingException

See Also:

MailRepository.retrieve(String)

internalRemove

protected void internalRemove(String key)
                       throws javax.mail.MessagingException

Specified by:

internalRemove in class AbstractMailRepository

Throws:

javax.mail.MessagingException

See Also:

AbstractMailRepository.internalRemove(String)

list

public Iterator list()

Description copied from interface: MailRepository

List string keys of messages in repository.

Returns:

an Iterator over the list of keys in the repository

See Also:

MailRepository.list()