org.apache.james.mailbox.hbase.mail

Class HBaseMailboxMapper

java.lang.Object

org.apache.james.mailbox.store.transaction.NonTransactionalMapper

org.apache.james.mailbox.hbase.HBaseNonTransactionalMapper

org.apache.james.mailbox.hbase.mail.HBaseMailboxMapper

All Implemented Interfaces:

MailboxMapper<UUID>, Mapper

public class HBaseMailboxMapper
extends HBaseNonTransactionalMapper
implements MailboxMapper<UUID>

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

Constructor Summary

Constructors

Constructor and Description
HBaseMailboxMapper(org.apache.hadoop.conf.Configuration conf)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Mailbox<UUID> mlbx) Delete the given Mailbox from the underlying storage
void	deleteAllMailboxes()
void	deleteAllMemberships()
void	endRequest() End request
Mailbox<UUID>	findMailboxByPath(MailboxPath mailboxPath) Return the Mailbox for the given name
List<Mailbox<UUID>>	findMailboxWithPathLike(MailboxPath mailboxPath) Return a List of Mailbox which name is like the given name
boolean	hasChildren(Mailbox<UUID> mailbox, char c) Return if the given Mailbox has children
List<Mailbox<UUID>>	list() Return a unmodifable List of all Mailbox
void	save(Mailbox<UUID> mlbx) Save the give Mailbox to the underlying storage

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

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

execute

Constructor Detail

HBaseMailboxMapper

public HBaseMailboxMapper(org.apache.hadoop.conf.Configuration conf)

Method Detail

findMailboxByPath

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

Description copied from interface: MailboxMapper

Return the Mailbox for the given name

Specified by:

findMailboxByPath in interface MailboxMapper<UUID>

Returns:

mailbox

Throws:

MailboxException

MailboxNotFoundException

findMailboxWithPathLike

public List<Mailbox<UUID>> findMailboxWithPathLike(MailboxPath mailboxPath)
                                            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<UUID>

Returns:

mailboxList

Throws:

MailboxException

list

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

Description copied from interface: MailboxMapper

Return a unmodifable List of all Mailbox

Specified by:

list in interface MailboxMapper<UUID>

Returns:

mailboxList

Throws:

MailboxException

endRequest

public void endRequest()

Description copied from class: HBaseNonTransactionalMapper

End request

Specified by:

endRequest in interface Mapper

Overrides:

endRequest in class HBaseNonTransactionalMapper

save

public void save(Mailbox<UUID> mlbx)
          throws MailboxException

Description copied from interface: MailboxMapper

Save the give Mailbox to the underlying storage

Specified by:

save in interface MailboxMapper<UUID>

Throws:

MailboxException

delete

public void delete(Mailbox<UUID> mlbx)
            throws MailboxException

Description copied from interface: MailboxMapper

Delete the given Mailbox from the underlying storage

Specified by:

delete in interface MailboxMapper<UUID>

Throws:

MailboxException

hasChildren

public boolean hasChildren(Mailbox<UUID> mailbox,
                  char c)
                    throws MailboxException,
                           MailboxNotFoundException

Description copied from interface: MailboxMapper

Return if the given Mailbox has children

Specified by:

hasChildren in interface MailboxMapper<UUID>

Parameters:

mailbox - not null

c - path delimiter

Returns:

true when the mailbox has children, false otherwise

Throws:

MailboxException

MailboxNotFoundException

deleteAllMemberships

public void deleteAllMemberships()

deleteAllMailboxes

public void deleteAllMailboxes()