org.apache.james.mailbox.jcr.mail

Class JCRMailboxMapper

java.lang.Object

org.apache.james.mailbox.store.transaction.TransactionalMapper

org.apache.james.mailbox.jcr.AbstractJCRScalingMapper

org.apache.james.mailbox.jcr.mail.JCRMailboxMapper

All Implemented Interfaces:

JCRImapConstants, MailboxMapper<String>, Mapper

public class JCRMailboxMapper
extends AbstractJCRScalingMapper
implements MailboxMapper<String>

JCR implementation of a MailboxMapper

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.transaction.Mapper

Mapper.Transaction<T>, Mapper.VoidTransaction

Field Summary

Fields inherited from class org.apache.james.mailbox.jcr.AbstractJCRScalingMapper

MAILBOXES_PATH

Fields inherited from interface org.apache.james.mailbox.jcr.JCRImapConstants

NODE_DELIMITER

Constructor Summary

Constructors

Constructor and Description
JCRMailboxMapper(MailboxSessionJCRRepository repos, MailboxSession session, int scaling)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Mailbox<String> mailbox) Delete the given Mailbox from the underlying storage
Mailbox<String>	findMailboxByPath(MailboxPath path) Return the Mailbox for the given name
List<Mailbox<String>>	findMailboxWithPathLike(MailboxPath path) Return a List of Mailbox which name is like the given name
boolean	hasChildren(Mailbox<String> mailbox, char delimiter) Return if the given Mailbox has children
List<Mailbox<String>>	list() Return a unmodifable List of all Mailbox
void	save(Mailbox<String> mailbox) Save the give Mailbox to the underlying storage

Methods inherited from class org.apache.james.mailbox.jcr.AbstractJCRScalingMapper

begin, commit, constructUserPathPart, createUserPathStructure, endRequest, getLogger, getSession, rollback

Methods inherited from class org.apache.james.mailbox.store.transaction.TransactionalMapper

execute

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.mailbox.store.transaction.Mapper

endRequest, execute

Constructor Detail

JCRMailboxMapper

public JCRMailboxMapper(MailboxSessionJCRRepository repos,
                MailboxSession session,
                int scaling)

Method Detail

delete

public void delete(Mailbox<String> mailbox)
            throws MailboxException

Description copied from interface: MailboxMapper

Delete the given Mailbox from the underlying storage

Specified by:

delete in interface MailboxMapper<String>

Throws:

MailboxException

findMailboxByPath

public Mailbox<String> findMailboxByPath(MailboxPath path)
                                  throws MailboxException,
                                         MailboxNotFoundException

Description copied from interface: MailboxMapper

Return the Mailbox for the given name

Specified by:

findMailboxByPath in interface MailboxMapper<String>

Returns:

mailbox

Throws:

MailboxException

MailboxNotFoundException

findMailboxWithPathLike

public List<Mailbox<String>> findMailboxWithPathLike(MailboxPath path)
                                              throws MailboxException

Description copied from interface: MailboxMapper

Return a List of Mailbox which name is like the given name

Specified by:

findMailboxWithPathLike in interface MailboxMapper<String>

Returns:

mailboxList

Throws:

MailboxException

save

public void save(Mailbox<String> mailbox)
          throws MailboxException

Description copied from interface: MailboxMapper

Save the give Mailbox to the underlying storage

Specified by:

save in interface MailboxMapper<String>

Throws:

MailboxException

hasChildren

public boolean hasChildren(Mailbox<String> mailbox,
                  char delimiter)
                    throws MailboxException,
                           MailboxNotFoundException

Description copied from interface: MailboxMapper

Return if the given Mailbox has children

Specified by:

hasChildren in interface MailboxMapper<String>

Parameters:

mailbox - not null

delimiter - path delimiter

Returns:

true when the mailbox has children, false otherwise

Throws:

MailboxException

MailboxNotFoundException

list

public List<Mailbox<String>> list()
                           throws MailboxException

Description copied from interface: MailboxMapper

Return a unmodifable List of all Mailbox

Specified by:

list in interface MailboxMapper<String>

Returns:

mailboxList

Throws:

MailboxException