org.apache.james.mailbox.store

Class StoreMailboxManager<Id>

java.lang.Object

org.apache.james.mailbox.store.StoreMailboxManager<Id>

Type Parameters:

Id -

All Implemented Interfaces:

MailboxListenerSupport, MailboxManager, RequestAware

Direct Known Subclasses:

HBaseMailboxManager, JCRMailboxManager, JPAMailboxManager

public class StoreMailboxManager<Id>
extends Object
implements MailboxManager

This base class of an MailboxManager implementation provides a high-level api for writing your own MailboxManager implementation. If you plan to write your own MailboxManager its most times so easiest to extend just this class or use it directly. If you need a more low-level api just implement MailboxManager directly

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FETCH_BATCH_SIZE
static char	SQL_WILDCARD_CHAR

Constructor Summary

Constructors

Constructor and Description
StoreMailboxManager(MailboxSessionMapperFactory<Id> mailboxSessionMapperFactory, Authenticator authenticator, MailboxACLResolver aclResolver, GroupMembershipResolver groupMembershipResolver)
StoreMailboxManager(MailboxSessionMapperFactory<Id> mailboxSessionMapperFactory, Authenticator authenticator, MailboxPathLocker locker, MailboxACLResolver aclResolver, GroupMembershipResolver groupMembershipResolver)

Method Summary

Methods

Modifier and Type	Method and Description
void	addGlobalListener(MailboxListener listener, MailboxSession session) Add a MailboxListener which get fired for ever MailboxPath
void	addListener(MailboxPath path, MailboxListener listener, MailboxSession session) Implementations of Mailbox may interpret the fact that someone is listening and do some caching and even postpone persistence until everyone has removed itself.
List<MessageRange>	copyMessages(MessageRange set, MailboxPath from, MailboxPath to, MailboxSession session) Copy the given MessageRange from one Mailbox to the other.
void	createMailbox(MailboxPath mailboxPath, MailboxSession mailboxSession) Creates a new mailbox.
protected StoreMessageManager<Id>	createMessageManager(Mailbox<Id> mailbox, MailboxSession session) Create a MailboxManager for the given Mailbox.
protected MailboxSession	createSession(String userName, String password, org.slf4j.Logger log, MailboxSession.SessionType type) Create Session
MailboxSession	createSystemSession(String userName, org.slf4j.Logger log) Creates a new system session. A system session is intended to be used for programmatic access. Use MailboxManager.login(String, String, Logger) when accessing this API from a protocol.
void	deleteMailbox(MailboxPath mailboxPath, MailboxSession session) Delete the mailbox with the name
protected Mailbox<Id>	doCreateMailbox(MailboxPath mailboxPath, MailboxSession session) Create a Mailbox for the given mailbox path.
void	endProcessingRequest(MailboxSession session) End processing of Request for session
MailboxACLResolver	getAclResolver()
AbstractDelegatingMailboxListener	getDelegationListener() Return the AbstractDelegatingMailboxListener which is used by this MailboxManager
char	getDelimiter() Return the delimiter to use for folders
MailboxEventDispatcher<Id>	getEventDispatcher() Return the MailboxEventDispatcher used by thei MailboxManager
GroupMembershipResolver	getGroupMembershipResolver()
MailboxPathLocker	getLocker()
MessageManager	getMailbox(MailboxPath mailboxPath, MailboxSession session) Gets an session suitable for IMAP.
MailboxSessionMapperFactory<Id>	getMapperFactory() Return the MailboxSessionMapperFactory used by this MailboxManager
MessageSearchIndex<Id>	getMessageSearchIndex() Return the MessageSearchIndex used by this MailboxManager
void	init() Init the MailboxManager
List<MailboxPath>	list(MailboxSession session) Return a unmodifiable List of MailboxPath objects
MailboxSession	login(String userid, String passwd, org.slf4j.Logger log) Autenticates the given user against the given password. When authentic and authorized, a session will be supplied
void	logout(MailboxSession session, boolean force) Close the MailboxSession if not null
boolean	mailboxExists(MailboxPath mailboxPath, MailboxSession session) Does the given mailbox exist?
protected long	randomId() Generate and return the next id to use
protected int	randomUidValidity() Generate an return the next uid validity
void	removeGlobalListener(MailboxListener listener, MailboxSession session) Remove the MailboxListener
void	removeListener(MailboxPath mailboxPath, MailboxListener listener, MailboxSession session) Remove the MailboxListener
void	renameMailbox(MailboxPath from, MailboxPath to, MailboxSession session) Renames a mailbox.
List<MailboxMetaData>	search(MailboxQuery mailboxExpression, MailboxSession session) Searches for mailboxes matching the given query.
void	setCopyBatchSize(int copyBatchSize)
void	setDelegatingMailboxListener(AbstractDelegatingMailboxListener delegatingListener) Set the AbstractDelegatingMailboxListener to use with this MailboxManager instance.
void	setFetchBatchSize(int fetchBatchSize)
void	setMailboxSessionIdGenerator(MailboxSessionIdGenerator idGenerator)
void	setMessageSearchIndex(MessageSearchIndex<Id> index) Set the MessageSearchIndex which should be used by this MailboxManager.
void	startProcessingRequest(MailboxSession session) Do nothing.

Methods inherited from class java.lang.Object

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

Field Detail

SQL_WILDCARD_CHAR

public static final char SQL_WILDCARD_CHAR

See Also:

Constant Field Values

DEFAULT_FETCH_BATCH_SIZE

public static final int DEFAULT_FETCH_BATCH_SIZE

See Also:

Constant Field Values

Constructor Detail

StoreMailboxManager

public StoreMailboxManager(MailboxSessionMapperFactory<Id> mailboxSessionMapperFactory,
                   Authenticator authenticator,
                   MailboxPathLocker locker,
                   MailboxACLResolver aclResolver,
                   GroupMembershipResolver groupMembershipResolver)

StoreMailboxManager

public StoreMailboxManager(MailboxSessionMapperFactory<Id> mailboxSessionMapperFactory,
                   Authenticator authenticator,
                   MailboxACLResolver aclResolver,
                   GroupMembershipResolver groupMembershipResolver)

Method Detail

setMailboxSessionIdGenerator

public void setMailboxSessionIdGenerator(MailboxSessionIdGenerator idGenerator)

setCopyBatchSize

public void setCopyBatchSize(int copyBatchSize)

setFetchBatchSize

public void setFetchBatchSize(int fetchBatchSize)

init

public void init()
          throws MailboxException

Init the MailboxManager

Throws:

MailboxException

getDelegationListener

public AbstractDelegatingMailboxListener getDelegationListener()

Return the AbstractDelegatingMailboxListener which is used by this MailboxManager

Returns:

delegatingListener

getMessageSearchIndex

public MessageSearchIndex<Id> getMessageSearchIndex()

Return the MessageSearchIndex used by this MailboxManager

Returns:

index

getEventDispatcher

public MailboxEventDispatcher<Id> getEventDispatcher()

Return the MailboxEventDispatcher used by thei MailboxManager

Returns:

dispatcher

getMapperFactory

public MailboxSessionMapperFactory<Id> getMapperFactory()

Return the MailboxSessionMapperFactory used by this MailboxManager

Returns:

mailboxSessionMapperFactory

getLocker

public MailboxPathLocker getLocker()

getAclResolver

public MailboxACLResolver getAclResolver()

getGroupMembershipResolver

public GroupMembershipResolver getGroupMembershipResolver()

setDelegatingMailboxListener

public void setDelegatingMailboxListener(AbstractDelegatingMailboxListener delegatingListener)

Set the AbstractDelegatingMailboxListener to use with this MailboxManager instance. If none is set here a HashMapDelegatingMailboxListener instance will be created lazy

Parameters:

delegatingListener -

setMessageSearchIndex

public void setMessageSearchIndex(MessageSearchIndex<Id> index)

Set the MessageSearchIndex which should be used by this MailboxManager. If none is given this implementation will use a SimpleMessageSearchIndex by default

Parameters:

index -

randomUidValidity

protected int randomUidValidity()

Generate an return the next uid validity

Returns:

uidValidity

createSystemSession

public MailboxSession createSystemSession(String userName,
                                 org.slf4j.Logger log)

Description copied from interface: MailboxManager

Creates a new system session.
A system session is intended to be used for programmatic access.
Use MailboxManager.login(String, String, Logger) when accessing this API from a protocol.

Specified by:

createSystemSession in interface MailboxManager

Parameters:

userName - the name of the user whose session is being created

log - context sensitive log

Returns:

MailboxSession, not null

See Also:

MailboxManager.createSystemSession(java.lang.String, org.slf4j.Logger)

createSession

protected MailboxSession createSession(String userName,
                           String password,
                           org.slf4j.Logger log,
                           MailboxSession.SessionType type)

Create Session

Parameters:

userName -

log -

Returns:

session

randomId

protected long randomId()

Generate and return the next id to use

Returns:

id

getDelimiter

public char getDelimiter()

Description copied from interface: MailboxManager

Return the delimiter to use for folders

Specified by:

getDelimiter in interface MailboxManager

Returns:

delimiter

See Also:

MailboxManager.getDelimiter()

login

public MailboxSession login(String userid,
                   String passwd,
                   org.slf4j.Logger log)
                     throws BadCredentialsException,
                            MailboxException

Description copied from interface: MailboxManager

Autenticates the given user against the given password.
When authentic and authorized, a session will be supplied

Specified by:

login in interface MailboxManager

Parameters:

userid - user name

passwd - password supplied

log - context sensitive log

Returns:

a MailboxSession when the user is authentic and authorized to access

Throws:

BadCredentialsException - when system access is denighed for the given user

MailboxException - when the creation fails for other reasons

See Also:

MailboxManager.login(java.lang.String, java.lang.String, org.slf4j.Logger)

logout

public void logout(MailboxSession session,
          boolean force)
            throws MailboxException

Close the MailboxSession if not null

Specified by:

logout in interface MailboxManager

Parameters:

session - not null

force - true when the session logout is forced by premature connection termination

Throws:

MailboxException - when logout fails

createMessageManager

protected StoreMessageManager<Id> createMessageManager(Mailbox<Id> mailbox,
                                           MailboxSession session)
                                                throws MailboxException

Create a MailboxManager for the given Mailbox. By default this will return a StoreMessageManager. If your implementation needs something different, just override this method

Parameters:

mailbox -

session -

Returns:

storeMailbox

Throws:

MailboxException

doCreateMailbox

protected Mailbox<Id> doCreateMailbox(MailboxPath mailboxPath,
                          MailboxSession session)
                               throws MailboxException

Create a Mailbox for the given mailbox path. This will by default return a SimpleMailbox. If you need to return something more special just override this method

Parameters:

mailboxPath -

session -

Throws:

MailboxException

getMailbox

public MessageManager getMailbox(MailboxPath mailboxPath,
                        MailboxSession session)
                          throws MailboxException

Description copied from interface: MailboxManager

Gets an session suitable for IMAP.

Specified by:

getMailbox in interface MailboxManager

Parameters:

mailboxPath - the Path of the mailbox, not null

session - the context for this call, not null

Returns:

ImapMailboxSession, not null

Throws:

MailboxException - when the mailbox cannot be opened

MailboxNotFoundException - when the given mailbox does not exist

See Also:

MailboxManager.getMailbox(MailboxPath, MailboxSession)

createMailbox

public void createMailbox(MailboxPath mailboxPath,
                 MailboxSession mailboxSession)
                   throws MailboxException

Description copied from interface: MailboxManager

Creates a new mailbox. Any intermediary mailboxes missing from the hierarchy should be created.

Specified by:

createMailbox in interface MailboxManager

mailboxSession - the context for this call, not null

Throws:

MailboxException - when creation fails

See Also:

MailboxManager.createMailbox(MailboxPath, MailboxSession)

deleteMailbox

public void deleteMailbox(MailboxPath mailboxPath,
                 MailboxSession session)
                   throws MailboxException

Description copied from interface: MailboxManager

Delete the mailbox with the name

Specified by:

deleteMailbox in interface MailboxManager

Throws:

MailboxException

See Also:

MailboxManager.deleteMailbox(MailboxPath, MailboxSession)

renameMailbox

public void renameMailbox(MailboxPath from,
                 MailboxPath to,
                 MailboxSession session)
                   throws MailboxException

Description copied from interface: MailboxManager

Renames a mailbox.

Specified by:

renameMailbox in interface MailboxManager

Parameters:

from - original mailbox

to - new mailbox

session - the context for this call, not nul

Throws:

MailboxException - otherwise

MailboxExistsException - when the to mailbox exists

See Also:

MailboxManager.renameMailbox(MailboxPath, MailboxPath, MailboxSession)

copyMessages

public List<MessageRange> copyMessages(MessageRange set,
                              MailboxPath from,
                              MailboxPath to,
                              MailboxSession session)
                                throws MailboxException

Description copied from interface: MailboxManager

Copy the given MessageRange from one Mailbox to the other. Be aware that the copied Messages MUST get the \RECENT flag set!

Specified by:

copyMessages in interface MailboxManager

Parameters:

set - messages to copy

from - name of the source mailbox

to - name of the destination mailbox

session - MailboxSession, not null

Returns:

a list of MessageRange - uids assigned to copied messages

Throws:

MailboxException

See Also:

MailboxManager.copyMessages(MessageRange, MailboxPath, MailboxPath, MailboxSession)

search

public List<MailboxMetaData> search(MailboxQuery mailboxExpression,
                           MailboxSession session)
                             throws MailboxException

Description copied from interface: MailboxManager

Searches for mailboxes matching the given query.

Specified by:

search in interface MailboxManager

Parameters:

mailboxExpression - not null

session - the context for this call, not null

Throws:

MailboxException

See Also:

MailboxManager.search(org.apache.james.mailbox.model.MailboxQuery, org.apache.james.mailbox.MailboxSession)

mailboxExists

public boolean mailboxExists(MailboxPath mailboxPath,
                    MailboxSession session)
                      throws MailboxException

Description copied from interface: MailboxManager

Does the given mailbox exist?

Specified by:

mailboxExists in interface MailboxManager

Parameters:

mailboxPath - not null

session - the context for this call, not null

Returns:

true when the mailbox exists and is accessible for the given user, false otherwise

Throws:

MailboxException

See Also:

MailboxManager.mailboxExists(MailboxPath, MailboxSession)

addListener

public void addListener(MailboxPath path,
               MailboxListener listener,
               MailboxSession session)
                 throws MailboxException

Description copied from interface: MailboxListenerSupport

Implementations of Mailbox may interpret the fact that someone is listening and do some caching and even postpone persistence until everyone has removed itself.

Specified by:

addListener in interface MailboxListenerSupport

Parameters:

path - not null

listener - not null

session - not null

Throws:

MailboxException

See Also:

MailboxListenerSupport.addListener(MailboxPath, MailboxListener, MailboxSession)

endProcessingRequest

public void endProcessingRequest(MailboxSession session)

End processing of Request for session

Specified by:

endProcessingRequest in interface RequestAware

startProcessingRequest

public void startProcessingRequest(MailboxSession session)

Do nothing. Sub classes should override this if needed

Specified by:

startProcessingRequest in interface RequestAware

list

public List<MailboxPath> list(MailboxSession session)
                       throws MailboxException

Description copied from interface: MailboxManager

Return a unmodifiable List of MailboxPath objects

Specified by:

list in interface MailboxManager

Returns:

pathList

Throws:

MailboxException

See Also:

MailboxManager.list(org.apache.james.mailbox.MailboxSession)

addGlobalListener

public void addGlobalListener(MailboxListener listener,
                     MailboxSession session)
                       throws MailboxException

Description copied from interface: MailboxListenerSupport

Add a MailboxListener which get fired for ever MailboxPath

Specified by:

addGlobalListener in interface MailboxListenerSupport

Throws:

MailboxException

See Also:

MailboxListenerSupport.addGlobalListener(org.apache.james.mailbox.MailboxListener, org.apache.james.mailbox.MailboxSession)

removeListener

public void removeListener(MailboxPath mailboxPath,
                  MailboxListener listener,
                  MailboxSession session)
                    throws MailboxException

Description copied from interface: MailboxListenerSupport

Remove the MailboxListener

Specified by:

removeListener in interface MailboxListenerSupport

Throws:

MailboxException

See Also:

MailboxListenerSupport.removeListener(org.apache.james.mailbox.model.MailboxPath, org.apache.james.mailbox.MailboxListener, org.apache.james.mailbox.MailboxSession)

removeGlobalListener

public void removeGlobalListener(MailboxListener listener,
                        MailboxSession session)
                          throws MailboxException

Description copied from interface: MailboxListenerSupport

Remove the MailboxListener

Specified by:

removeGlobalListener in interface MailboxListenerSupport

Throws:

MailboxException