org.apache.james.mailbox.jpa.mail

Class JPAMailboxMapper

java.lang.Object

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

org.apache.james.mailbox.jpa.JPATransactionalMapper

org.apache.james.mailbox.jpa.mail.JPAMailboxMapper

All Implemented Interfaces:

MailboxMapper<Long>, Mapper

public class JPAMailboxMapper
extends JPATransactionalMapper
implements MailboxMapper<Long>

Data access management for mailbox.

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.jpa.JPATransactionalMapper

entityManager, entityManagerFactory

Constructor Summary

Constructors

Constructor and Description
JPAMailboxMapper(javax.persistence.EntityManagerFactory entityManagerFactory)

Method Summary

Methods

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

Methods inherited from class org.apache.james.mailbox.jpa.JPATransactionalMapper

begin, endRequest, getEntityManager, 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

JPAMailboxMapper

public JPAMailboxMapper(javax.persistence.EntityManagerFactory entityManagerFactory)

Method Detail

commit

protected void commit()
               throws MailboxException

Commit the transaction. If the commit fails due a conflict in a unique key constraint a MailboxExistsException will get thrown

Overrides:

commit in class JPATransactionalMapper

Throws:

MailboxException

save

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

Description copied from interface: MailboxMapper

Save the give Mailbox to the underlying storage

Specified by:

save in interface MailboxMapper<Long>

Throws:

MailboxException

See Also:

MailboxMapper.save(Mailbox)

findMailboxByPath

public Mailbox<Long> findMailboxByPath(MailboxPath mailboxPath)
                                throws MailboxException,
                                       MailboxNotFoundException

Description copied from interface: MailboxMapper

Return the Mailbox for the given name

Specified by:

findMailboxByPath in interface MailboxMapper<Long>

Returns:

mailbox

Throws:

MailboxException

MailboxNotFoundException

See Also:

MailboxMapper.findMailboxByPath(MailboxPath)

delete

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

Description copied from interface: MailboxMapper

Delete the given Mailbox from the underlying storage

Specified by:

delete in interface MailboxMapper<Long>

Throws:

MailboxException

See Also:

MailboxMapper.delete(Mailbox)

findMailboxWithPathLike

public List<Mailbox<Long>> 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<Long>

Returns:

mailboxList

Throws:

MailboxException

See Also:

MailboxMapper.findMailboxWithPathLike(MailboxPath)

deleteAllMemberships

public void deleteAllMemberships()
                          throws MailboxException

Throws:

MailboxException

deleteAllMailboxes

public void deleteAllMailboxes()
                        throws MailboxException

Throws:

MailboxException

hasChildren

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

Description copied from interface: MailboxMapper

Return if the given Mailbox has children

Specified by:

hasChildren in interface MailboxMapper<Long>

Parameters:

mailbox - not null

delimiter - path delimiter

Returns:

true when the mailbox has children, false otherwise

Throws:

MailboxException

MailboxNotFoundException

See Also:

MailboxMapper.hasChildren(Mailbox, char)

list

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

Description copied from interface: MailboxMapper

Return a unmodifable List of all Mailbox

Specified by:

list in interface MailboxMapper<Long>

Returns:

mailboxList

Throws:

MailboxException

See Also:

MailboxMapper.list()