org.apache.james.mailbox.model

Class SimpleMailboxACL

java.lang.Object

org.apache.james.mailbox.model.SimpleMailboxACL

All Implemented Interfaces:

MailboxACL

public class SimpleMailboxACL
extends Object
implements MailboxACL

Default implementation of MailboxACL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleMailboxACL.Rfc4314Rights Supports only the Standard Rights of RFC 4314 section 2.1.
static class	SimpleMailboxACL.SimpleMailboxACLEntry A utility implementation of Map.Entry<MailboxACLEntryKey, MailboxACLRights>.
static class	SimpleMailboxACL.SimpleMailboxACLEntryKey Default implementation of MailboxACLEntryKey.
static class	SimpleMailboxACL.SimpleMailboxACLRight Default implementation of MailboxACL.MailboxACLRight.

Nested classes/interfaces inherited from interface org.apache.james.mailbox.model.MailboxACL

MailboxACL.EditMode, MailboxACL.MailboxACLEntryKey, MailboxACL.MailboxACLRight, MailboxACL.MailboxACLRights, MailboxACL.NameType, MailboxACL.SpecialName

Field Summary

Fields

Modifier and Type	Field and Description
static MailboxACL.MailboxACLEntryKey	ANYBODY_KEY
static MailboxACL.MailboxACLEntryKey	ANYBODY_NEGATIVE_KEY
static MailboxACL.MailboxACLEntryKey	AUTHENTICATED_KEY
static MailboxACL.MailboxACLEntryKey	AUTHENTICATED_NEGATIVE_KEY
static MailboxACL	EMPTY
static MailboxACL.MailboxACLRights	FULL_RIGHTS
static MailboxACL.MailboxACLRights	NO_RIGHTS
static MailboxACL	OWNER_FULL_ACL
static MailboxACL	OWNER_FULL_EXCEPT_ADMINISTRATION_ACL
static MailboxACL.MailboxACLEntryKey	OWNER_KEY
static MailboxACL.MailboxACLEntryKey	OWNER_NEGATIVE_KEY

Fields inherited from interface org.apache.james.mailbox.model.MailboxACL

ADD_RIGHTS_MARKER, DEFAULT_GROUP_MARKER, DEFAULT_NEGATIVE_MARKER, REMOVE_RIGHTS_MARKER

Constructor Summary

Constructors

Constructor and Description
SimpleMailboxACL() Creates a new instance of SimpleMailboxACL containing no entries.
SimpleMailboxACL(Map.Entry<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights>[] entries) Creates a new instance of SimpleMailboxACL from the given array of entries.
SimpleMailboxACL(Map<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights> entries) Creates a new instance of SimpleMailboxACL from the given Map of entries.
SimpleMailboxACL(Properties props) Creates a new instance of SimpleMailboxACL from Properties.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
MailboxACL	except(MailboxACL.MailboxACLEntryKey key, MailboxACL.MailboxACLRights mailboxACLRights) TODO except.
MailboxACL	except(MailboxACL other) Performs the set theoretic operation of relative complement of toRemove MailboxACL in this MailboxACL.
Map<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights>	getEntries() Map of entries.
int	hashCode()
MailboxACL	replace(MailboxACL.MailboxACLEntryKey key, MailboxACL.MailboxACLRights replacement) Replaces the entry corresponding to the given key with toAddlink MailboxACLRights}.
String	toString()
MailboxACL	union(MailboxACL.MailboxACLEntryKey key, MailboxACL.MailboxACLRights mailboxACLRights) TODO union.
MailboxACL	union(MailboxACL other) Performs the set theoretic operation of union of this MailboxACL and toAdd MailboxACL.

Methods inherited from class java.lang.Object

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

Field Detail

ANYBODY_KEY

public static final MailboxACL.MailboxACLEntryKey ANYBODY_KEY

ANYBODY_NEGATIVE_KEY

public static final MailboxACL.MailboxACLEntryKey ANYBODY_NEGATIVE_KEY

AUTHENTICATED_KEY

public static final MailboxACL.MailboxACLEntryKey AUTHENTICATED_KEY

AUTHENTICATED_NEGATIVE_KEY

public static final MailboxACL.MailboxACLEntryKey AUTHENTICATED_NEGATIVE_KEY

EMPTY

public static final MailboxACL EMPTY

FULL_RIGHTS

public static final MailboxACL.MailboxACLRights FULL_RIGHTS

NO_RIGHTS

public static final MailboxACL.MailboxACLRights NO_RIGHTS

OWNER_FULL_ACL

public static final MailboxACL OWNER_FULL_ACL

OWNER_FULL_EXCEPT_ADMINISTRATION_ACL

public static final MailboxACL OWNER_FULL_EXCEPT_ADMINISTRATION_ACL

OWNER_KEY

public static final MailboxACL.MailboxACLEntryKey OWNER_KEY

OWNER_NEGATIVE_KEY

public static final MailboxACL.MailboxACLEntryKey OWNER_NEGATIVE_KEY

Constructor Detail

SimpleMailboxACL

public SimpleMailboxACL()

Creates a new instance of SimpleMailboxACL containing no entries.

SimpleMailboxACL

public SimpleMailboxACL(Map.Entry<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights>[] entries)

Creates a new instance of SimpleMailboxACL from the given array of entries.

Parameters:

entries -

SimpleMailboxACL

public SimpleMailboxACL(Map<MailboxACL.MailboxACLEntryKey,MailboxACL.MailboxACLRights> entries)

Creates a new instance of SimpleMailboxACL from the given Map of entries.

Parameters:

entries -

SimpleMailboxACL

public SimpleMailboxACL(Properties props)
                 throws UnsupportedRightException

Creates a new instance of SimpleMailboxACL from Properties. The keys and values from the props parameter are parsed by the String constructors of SimpleMailboxACL.SimpleMailboxACLEntryKey and SimpleMailboxACL.Rfc4314Rights respectively.

Parameters:

props -

Throws:

UnsupportedRightException

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

except

public MailboxACL except(MailboxACL other)
                  throws UnsupportedRightException

Description copied from interface: MailboxACL

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"

Specified by:

except in interface MailboxACL

Returns:

Throws:

UnsupportedRightException

See Also:

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

except

public MailboxACL except(MailboxACL.MailboxACLEntryKey key,
                MailboxACL.MailboxACLRights mailboxACLRights)
                  throws UnsupportedRightException

Description copied from interface: MailboxACL

TODO except.

Specified by:

except in interface MailboxACL

Returns:

Throws:

UnsupportedRightException

See Also:

MailboxACL.except(org.apache.james.mailbox.model.MailboxACL.MailboxACLEntryKey, org.apache.james.mailbox.model.MailboxACL.MailboxACLRights)

getEntries

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

Description copied from interface: MailboxACL

Map of entries.

Specified by:

getEntries in interface MailboxACL

Returns:

the entries.

See Also:

org.apache.james.mailbox.MailboxACL#getEntries()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

replace

public MailboxACL replace(MailboxACL.MailboxACLEntryKey key,
                 MailboxACL.MailboxACLRights replacement)
                   throws UnsupportedRightException

Description copied from interface: MailboxACL

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).

Specified by:

replace in interface MailboxACL

Returns:

Throws:

UnsupportedRightException

See Also:

MailboxACL.replace(org.apache.james.mailbox.model.MailboxACL.MailboxACLEntryKey, org.apache.james.mailbox.model.MailboxACL.MailboxACLRights)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

union

public MailboxACL union(MailboxACL other)
                 throws UnsupportedRightException

Description copied from interface: MailboxACL

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.

Specified by:

union in interface MailboxACL

Returns:

Throws:

UnsupportedRightException

See Also:

org.apache.james.mailbox.MailboxACL#union(org.apache.james.mailbox.MailboxACL)

union

public MailboxACL union(MailboxACL.MailboxACLEntryKey key,
               MailboxACL.MailboxACLRights mailboxACLRights)
                 throws UnsupportedRightException

Description copied from interface: MailboxACL

TODO union.

Specified by:

union in interface MailboxACL

Returns:

Throws:

UnsupportedRightException

See Also:

MailboxACL.union(org.apache.james.mailbox.model.MailboxACL.MailboxACLEntryKey, org.apache.james.mailbox.model.MailboxACL.MailboxACLRights)