org.apache.james.mailbox.model

Interface MailboxACL

All Known Implementing Classes:

SimpleMailboxACL

public interface MailboxACL

Stores an Access Control List (ACL) applicable to a mailbox. Inspired by RFC4314 IMAP4 Access Control List (ACL) Extension. Implementations must be immutable. Implementations should override #hashCode() and #equals(Object).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MailboxACL.EditMode SETACL command mode.
static interface	MailboxACL.MailboxACLEntryKey The key used in getEntries().
static interface	MailboxACL.MailboxACLRight Single right applicable to a mailbox.
static interface	MailboxACL.MailboxACLRights Iterable set of MailboxACL.MailboxACLRights.
static class	MailboxACL.NameType Allows distinguishing between users, groups and special names (see MailboxACL.SpecialName).
static class	MailboxACL.SpecialName Special name literals.

Field Summary

Fields

Modifier and Type	Field and Description
static char	ADD_RIGHTS_MARKER SETACL third argument prefix
static char	DEFAULT_GROUP_MARKER Marks groups when (de)serializing MailboxACL.MailboxACLEntryKeys.
static char	DEFAULT_NEGATIVE_MARKER Marks negative when (de)serializing MailboxACL.MailboxACLEntryKeys.
static char	REMOVE_RIGHTS_MARKER SETACL third argument prefix

Method Summary

Methods

Modifier and Type	Method and Description
MailboxACL	except(MailboxACL.MailboxACLEntryKey key, MailboxACL.MailboxACLRights toRemove) TODO except.
MailboxACL	except(MailboxACL toRemove) Performs the set theoretic operation of relative complement of toRemove MailboxACL in this MailboxACL.
Map<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights>	getEntries() Map of entries.
MailboxACL	replace(MailboxACL.MailboxACLEntryKey key, MailboxACL.MailboxACLRights toAdd) Replaces the entry corresponding to the given key with toAddlink MailboxACLRights}.
MailboxACL	union(MailboxACL.MailboxACLEntryKey key, MailboxACL.MailboxACLRights toAdd) TODO union.
MailboxACL	union(MailboxACL toAdd) Performs the set theoretic operation of union of this MailboxACL and toAdd MailboxACL.

Field Detail

ADD_RIGHTS_MARKER

static final char ADD_RIGHTS_MARKER

SETACL third argument prefix

See Also:

Constant Field Values

DEFAULT_GROUP_MARKER

static final char DEFAULT_GROUP_MARKER

Marks groups when (de)serializing MailboxACL.MailboxACLEntryKeys.

See Also:

MailboxACL.MailboxACLEntryKey.serialize(), Constant Field Values

DEFAULT_NEGATIVE_MARKER

static final char DEFAULT_NEGATIVE_MARKER

Marks negative when (de)serializing MailboxACL.MailboxACLEntryKeys.

See Also:

MailboxACL.MailboxACLEntryKey.serialize(), Constant Field Values

REMOVE_RIGHTS_MARKER

static final char REMOVE_RIGHTS_MARKER

SETACL third argument prefix

See Also:

Constant Field Values

Method Detail

except

MailboxACL except(MailboxACL toRemove)
                  throws UnsupportedRightException

Performs the set theoretic operation of relative complement of toRemove MailboxACL in this MailboxACL. A schematic example: "user1:lr;user2:lrwt".except("user1:w;user2:t") returns "user1:lr;user2:lrw". Implementations must return a new unmodifiable instance of MailboxACL. However, implementations may decide to return this or toRemove parameter value in case the result would be equal to the respective one of those. Implementations must ensure that the result does not contain entries with empty rigths. E.g. "user1:lr;user2:lrwt".except("user1:lr") should return "user2:lrwt" rather than "user1:;user2:lrwt"

Parameters:

toRemove -

Returns:

Throws:

UnsupportedRightException

except

MailboxACL except(MailboxACL.MailboxACLEntryKey key,
                MailboxACL.MailboxACLRights toRemove)
                  throws UnsupportedRightException

TODO except.

Parameters:

key -

toRemove -

Returns:

Throws:

UnsupportedRightException

getEntries

Map<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights> getEntries()

Map of entries.

Returns:

the entries.

replace

MailboxACL replace(MailboxACL.MailboxACLEntryKey key,
                 MailboxACL.MailboxACLRights toAdd)
                   throws UnsupportedRightException

Replaces the entry corresponding to the given key with toAddlink MailboxACLRights}. Implementations must return a new unmodifiable instance of MailboxACL. However, implementations may decide to return this in case the result would be equal to it. Implementations must ensure that the result does not contain entries with empty rigths. E.g. "user1:lr;user2:lrwt".replace("user1", MailboxACLRights.EMPTY) should return "user2:lrwt" rather than "user1:;user2:lrwt". The same result should be returned by "user1:lr;user2:lrwt".replace("user1", null).

Parameters:

key -

toAdd -

Returns:

Throws:

UnsupportedRightException

union

MailboxACL union(MailboxACL toAdd)
                 throws UnsupportedRightException

Performs the set theoretic operation of union of this MailboxACL and toAdd MailboxACL. A schematic example: "user1:lr;user2:lrwt".union("user1:at;-$group1:lrwt") returns "user1:alrt;user2:lrwt;-$group1:lrwt". Implementations must return a new unmodifiable instance of MailboxACL. However, implementations may decide to return this or toAdd parameter value in case the result would be equal to the respective one of those.

Parameters:

toAdd -

Returns:

Throws:

UnsupportedRightException

union

MailboxACL union(MailboxACL.MailboxACLEntryKey key,
               MailboxACL.MailboxACLRights toAdd)
                 throws UnsupportedRightException

TODO union.

Parameters:

key -

toAdd -

Returns:

Throws:

UnsupportedRightException