org.apache.james.mailrepository.lib

Class AbstractMailRepository

java.lang.Object

org.apache.james.mailrepository.lib.AbstractMailRepository

All Implemented Interfaces:

Configurable, LogEnabled, MailRepository

Direct Known Subclasses:

FileMailRepository, JCRMailRepository, JDBCMailRepository

public abstract class AbstractMailRepository
extends Object
implements MailRepository, LogEnabled, Configurable

This class represent an AbstractMailRepository. All MailRepositories should extend this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEEP_DEBUG Whether 'deep debugging' is turned on.

Constructor Summary

Constructors

Constructor and Description
AbstractMailRepository()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.commons.configuration.HierarchicalConfiguration configuration) Configure the object.
protected void	doConfigure(org.apache.commons.configuration.HierarchicalConfiguration config)
protected org.slf4j.Logger	getLogger()
protected abstract void	internalRemove(String key)
protected abstract void	internalStore(org.apache.mailet.Mail mc)
boolean	lock(String key) Obtains a lock on a message identified by key
void	remove(Collection<org.apache.mailet.Mail> mails) Remove an Collection of mails from the repository
void	remove(org.apache.mailet.Mail mail) Removes a specified message
void	remove(String key) Removes a message identified by key.
void	setLog(org.slf4j.Logger logger) Sets the service log.
void	store(org.apache.mailet.Mail mc) Stores a message in this repository.
boolean	unlock(String key) Releases a lock on a message identified the key

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.mailrepository.api.MailRepository

list, retrieve

Field Detail

DEEP_DEBUG

protected static final boolean DEEP_DEBUG

Whether 'deep debugging' is turned on.

See Also:

Constant Field Values

Constructor Detail

AbstractMailRepository

public AbstractMailRepository()

Method Detail

setLog

public void setLog(org.slf4j.Logger logger)

Description copied from interface: LogEnabled

Sets the service log.

Specified by:

setLog in interface LogEnabled

Parameters:

logger - not null

getLogger

protected org.slf4j.Logger getLogger()

configure

public void configure(org.apache.commons.configuration.HierarchicalConfiguration configuration)
               throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: Configurable

Configure the object. Be aware that no services are injected when this is called. If you need to access injected stuff do it in a method annotated with @PostConstruct

Specified by:

configure in interface Configurable

Throws:

org.apache.commons.configuration.ConfigurationException

doConfigure

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

Throws:

org.apache.commons.configuration.ConfigurationException

unlock

public boolean unlock(String key)

Description copied from interface: MailRepository

Releases a lock on a message identified the key

Specified by:

unlock in interface MailRepository

Parameters:

key - the key of the message to be unlocked

Returns:

true if successfully released the lock, false otherwise

See Also:

MailRepository.unlock(String)

lock

public boolean lock(String key)

Description copied from interface: MailRepository

Obtains a lock on a message identified by key

Specified by:

lock in interface MailRepository

Parameters:

key - the key of the message to be locked

Returns:

true if successfully obtained the lock, false otherwise

See Also:

MailRepository.lock(String)

store

public void store(org.apache.mailet.Mail mc)
           throws javax.mail.MessagingException

Description copied from interface: MailRepository

Stores a message in this repository. TODO: Shouldn't this return the key under which it is stored?

Specified by:

store in interface MailRepository

Parameters:

mc - the mail message to store

Throws:

javax.mail.MessagingException

See Also:

MailRepository.store(Mail)

internalStore

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

Throws:

javax.mail.MessagingException

IOException

See Also:

store(Mail)

remove

public void remove(org.apache.mailet.Mail mail)
            throws javax.mail.MessagingException

Description copied from interface: MailRepository

Removes a specified message

Specified by:

remove in interface MailRepository

Parameters:

mail - the message to be removed from the repository

Throws:

javax.mail.MessagingException

See Also:

MailRepository.remove(Mail)

remove

public void remove(Collection<org.apache.mailet.Mail> mails)
            throws javax.mail.MessagingException

Description copied from interface: MailRepository

Remove an Collection of mails from the repository

Specified by:

remove in interface MailRepository

Parameters:

mails - The Collection of MailImpl's to delete

Throws:

javax.mail.MessagingException

See Also:

MailRepository.remove(Collection)

remove

public void remove(String key)
            throws javax.mail.MessagingException

Description copied from interface: MailRepository

Removes a message identified by key.

Specified by:

remove in interface MailRepository

Parameters:

key - the key of the message to be removed from the repository

Throws:

javax.mail.MessagingException

See Also:

MailRepository.remove(String)

internalRemove

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

Throws:

javax.mail.MessagingException

See Also:

remove(String)