org.apache.james.mailbox.model

Class SimpleMailboxACL.Rfc4314Rights

java.lang.Object

org.apache.james.mailbox.model.SimpleMailboxACL.Rfc4314Rights

All Implemented Interfaces:

Iterable<MailboxACL.MailboxACLRight>, MailboxACL.MailboxACLRights

Enclosing class:

SimpleMailboxACL

public static class SimpleMailboxACL.Rfc4314Rights
extends Object
implements MailboxACL.MailboxACLRights

Supports only the Standard Rights of RFC 4314 section 2.1. The rights are stored as single bits in 32 bit int value field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleMailboxACL.Rfc4314Rights.CompatibilityMode See RFC 4314 section 2.1.1.

Field Summary

Fields

Modifier and Type	Field and Description
static char	a_Administer a - administer (perform SETACL/DELETEACL/GETACL/LISTRIGHTS)
static MailboxACL.MailboxACLRight	a_Administer_RIGHT
static char	c_ObsoleteCreate
static char	d_ObsoleteDelete
static char	e_PerformExpunge e - perform EXPUNGE and expunge as a part of CLOSE
static MailboxACL.MailboxACLRight	e_PerformExpunge_RIGHT
static int	EMPTY_MASK
static int	FIELD_COUNT
static char	i_Insert i - insert (perform APPEND, COPY into mailbox)
static MailboxACL.MailboxACLRight	i_Insert_RIGHT
static char	k_CreateMailbox k - create mailboxes (CREATE new sub-mailboxes in any implementation-defined hierarchy, parent mailbox for the new mailbox name in RENAME)
static MailboxACL.MailboxACLRight	k_CreateMailbox_RIGHT
static char	l_Lookup l - lookup (mailbox is visible to LIST/LSUB commands, SUBSCRIBE mailbox)
static MailboxACL.MailboxACLRight	l_Lookup_RIGHT
static char	p_Post p - post (send mail to submission address for mailbox, not enforced by IMAP4 itself)
static MailboxACL.MailboxACLRight	p_Post_RIGHT
static char	r_Read r - read (SELECT the mailbox, perform STATUS)
static MailboxACL.MailboxACLRight	r_Read_RIGHT
static char	s_WriteSeenFlag s - keep seen/unseen information across sessions (set or clear \SEEN flag via STORE, also set \SEEN during APPEND/COPY/ FETCH BODY[...])
static MailboxACL.MailboxACLRight	s_WriteSeenFlag_RIGHT
static char	t_DeleteMessages
static MailboxACL.MailboxACLRight	t_DeleteMessages_RIGHT
static char	w_Write w - write (set or clear flags other than \SEEN and \DELETED via STORE, also set them during APPEND/COPY)
static MailboxACL.MailboxACLRight	w_Write_RIGHT
static char	x_DeleteMailbox x - delete mailbox (DELETE mailbox, old mailbox name in RENAME)
static MailboxACL.MailboxACLRight	x_DeleteMailbox_RIGHT

Constructor Summary

Constructors

Constructor and Description
SimpleMailboxACL.Rfc4314Rights(boolean canAdminister, boolean canCreateMailbox, boolean canDeleteMailbox, boolean canDeleteMessages, boolean canInsert, boolean canLookup, boolean canPerformExpunge, boolean canPost, boolean canRead, boolean canWrite, boolean canWriteSeenFlag)
SimpleMailboxACL.Rfc4314Rights(int value)
SimpleMailboxACL.Rfc4314Rights(MailboxACL.MailboxACLRight right)
SimpleMailboxACL.Rfc4314Rights(String serializedRfc4314Rights)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(char flag)
boolean	contains(MailboxACL.MailboxACLRight right) Tells whether this contains the given right.
boolean	equals(Object o)
MailboxACL.MailboxACLRights	except(MailboxACL.MailboxACLRights toRemove) Performs the set theoretic operation of relative complement of toRemove MailboxACLRights in this MailboxACLRights.
int	getValue()
int	hashCode() Returns value.
boolean	isEmpty() Tells if this set of rights is empty.
boolean	isSupported(MailboxACL.MailboxACLRight right) Tells whether the implementation supports the given right.
Iterator<MailboxACL.MailboxACLRight>	iterator()
String	serialize() Returns a serialized form of this MailboxACL.MailboxACLRights as String.
String	toString() Returns serialize()
MailboxACL.MailboxACLRights	union(MailboxACL.MailboxACLRights toAdd) Performs the set theoretic operation of union of this MailboxACLRights and toAdd MailboxACLRights.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

a_Administer

public static final char a_Administer

a - administer (perform SETACL/DELETEACL/GETACL/LISTRIGHTS)

See Also:

Constant Field Values

a_Administer_RIGHT

public static final MailboxACL.MailboxACLRight a_Administer_RIGHT

c_ObsoleteCreate

public static final char c_ObsoleteCreate

See Also:

Constant Field Values

d_ObsoleteDelete

public static final char d_ObsoleteDelete

See Also:

Constant Field Values

e_PerformExpunge

public static final char e_PerformExpunge

e - perform EXPUNGE and expunge as a part of CLOSE

See Also:

Constant Field Values

e_PerformExpunge_RIGHT

public static final MailboxACL.MailboxACLRight e_PerformExpunge_RIGHT

EMPTY_MASK

public static final int EMPTY_MASK

See Also:

Constant Field Values

FIELD_COUNT

public static final int FIELD_COUNT

See Also:

Constant Field Values

i_Insert

public static final char i_Insert

i - insert (perform APPEND, COPY into mailbox)

See Also:

Constant Field Values

i_Insert_RIGHT

public static final MailboxACL.MailboxACLRight i_Insert_RIGHT

k_CreateMailbox

public static final char k_CreateMailbox

k - create mailboxes (CREATE new sub-mailboxes in any implementation-defined hierarchy, parent mailbox for the new mailbox name in RENAME)

See Also:

Constant Field Values

k_CreateMailbox_RIGHT

public static final MailboxACL.MailboxACLRight k_CreateMailbox_RIGHT

l_Lookup

public static final char l_Lookup

l - lookup (mailbox is visible to LIST/LSUB commands, SUBSCRIBE mailbox)

See Also:

Constant Field Values

l_Lookup_RIGHT

public static final MailboxACL.MailboxACLRight l_Lookup_RIGHT

p_Post

public static final char p_Post

p - post (send mail to submission address for mailbox, not enforced by IMAP4 itself)

See Also:

Constant Field Values

p_Post_RIGHT

public static final MailboxACL.MailboxACLRight p_Post_RIGHT

r_Read

public static final char r_Read

r - read (SELECT the mailbox, perform STATUS)

See Also:

Constant Field Values

r_Read_RIGHT

public static final MailboxACL.MailboxACLRight r_Read_RIGHT

s_WriteSeenFlag

public static final char s_WriteSeenFlag

s - keep seen/unseen information across sessions (set or clear \SEEN flag via STORE, also set \SEEN during APPEND/COPY/ FETCH BODY[...])

See Also:

Constant Field Values

s_WriteSeenFlag_RIGHT

public static final MailboxACL.MailboxACLRight s_WriteSeenFlag_RIGHT

t_DeleteMessages

public static final char t_DeleteMessages

See Also:

Constant Field Values

t_DeleteMessages_RIGHT

public static final MailboxACL.MailboxACLRight t_DeleteMessages_RIGHT

w_Write

public static final char w_Write

w - write (set or clear flags other than \SEEN and \DELETED via STORE, also set them during APPEND/COPY)

See Also:

Constant Field Values

w_Write_RIGHT

public static final MailboxACL.MailboxACLRight w_Write_RIGHT

x_DeleteMailbox

public static final char x_DeleteMailbox

x - delete mailbox (DELETE mailbox, old mailbox name in RENAME)

See Also:

Constant Field Values

x_DeleteMailbox_RIGHT

public static final MailboxACL.MailboxACLRight x_DeleteMailbox_RIGHT

Constructor Detail

SimpleMailboxACL.Rfc4314Rights

public SimpleMailboxACL.Rfc4314Rights(boolean canAdminister,
                              boolean canCreateMailbox,
                              boolean canDeleteMailbox,
                              boolean canDeleteMessages,
                              boolean canInsert,
                              boolean canLookup,
                              boolean canPerformExpunge,
                              boolean canPost,
                              boolean canRead,
                              boolean canWrite,
                              boolean canWriteSeenFlag)

SimpleMailboxACL.Rfc4314Rights

public SimpleMailboxACL.Rfc4314Rights(int value)
                               throws UnsupportedRightException

Throws:

UnsupportedRightException

SimpleMailboxACL.Rfc4314Rights

public SimpleMailboxACL.Rfc4314Rights(MailboxACL.MailboxACLRight right)
                               throws UnsupportedRightException

Throws:

UnsupportedRightException

SimpleMailboxACL.Rfc4314Rights

public SimpleMailboxACL.Rfc4314Rights(String serializedRfc4314Rights)
                               throws UnsupportedRightException

Throws:

UnsupportedRightException

Method Detail

contains

public boolean contains(char flag)
                 throws UnsupportedRightException

Throws:

UnsupportedRightException

contains

public boolean contains(MailboxACL.MailboxACLRight right)
                 throws UnsupportedRightException

Description copied from interface: MailboxACL.MailboxACLRights

Tells whether this contains the given right.

Specified by:

contains in interface MailboxACL.MailboxACLRights

Returns:

Throws:

UnsupportedRightException - iff the given right is not supported.

See Also:

org.apache.james.mailbox.MailboxACL.MailboxACLRights#contains(org .apache.james.mailbox.MailboxACL.MailboxACLRight)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

except

public MailboxACL.MailboxACLRights except(MailboxACL.MailboxACLRights toRemove)
                                   throws UnsupportedRightException

Description copied from interface: MailboxACL.MailboxACLRights

Performs the set theoretic operation of relative complement of toRemove MailboxACLRights in this MailboxACLRights. A schematic example: "lrw".except("w") returns "lr". Implementations must return a new unmodifiable instance of MailboxACL.MailboxACLRights. However, implementations may decide to return this or toRemove parameter value in case the result would be equal to the respective one of those.

Specified by:

except in interface MailboxACL.MailboxACLRights

Returns:

Throws:

UnsupportedRightException

See Also:

org.apache.james.mailbox.MailboxACL.MailboxACLRights#except(org.apache .james.mailbox.MailboxACL.MailboxACLRights)

getValue

public int getValue()

hashCode

public int hashCode()

Returns value.

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

isEmpty

public boolean isEmpty()

Description copied from interface: MailboxACL.MailboxACLRights

Tells if this set of rights is empty.

Specified by:

isEmpty in interface MailboxACL.MailboxACLRights

Returns:

true if there are no rights in this set; false otherwise.

See Also:

MailboxACL.MailboxACLRights.isEmpty()

isSupported

public boolean isSupported(MailboxACL.MailboxACLRight right)

Description copied from interface: MailboxACL.MailboxACLRights

Tells whether the implementation supports the given right.

Specified by:

isSupported in interface MailboxACL.MailboxACLRights

Returns:

true if this supports the given right.

See Also:

org.apache.james.mailbox.MailboxACL.MailboxACLRights#isSupported( org.apache.james.mailbox.MailboxACL.MailboxACLRight)

iterator

public Iterator<MailboxACL.MailboxACLRight> iterator()

Specified by:

iterator in interface Iterable<MailboxACL.MailboxACLRight>

serialize

public String serialize()

Description copied from interface: MailboxACL.MailboxACLRights

Returns a serialized form of this MailboxACL.MailboxACLRights as String.

Specified by:

serialize in interface MailboxACL.MailboxACLRights

Returns:

a String

toString

public String toString()

Returns serialize()

Overrides:

toString in class Object

See Also:

Object.toString()

union

public MailboxACL.MailboxACLRights union(MailboxACL.MailboxACLRights toAdd)
                                  throws UnsupportedRightException

Description copied from interface: MailboxACL.MailboxACLRights

Performs the set theoretic operation of union of this MailboxACLRights and toAdd MailboxACLRights. A schematic example: "lr".union("rw") returns "lrw". Implementations must return a new unmodifiable instance of MailboxACL.MailboxACLRights. However, implementations may decide to return this or toAdd parameter value in case the result would be equal to the respective one of those.

Specified by:

union in interface MailboxACL.MailboxACLRights

Returns:

union of this and toAdd

Throws:

UnsupportedRightException