The Rights class represents the set of rights for an authentication identifier (for instance, a user or a group).

A right is represented by the Rights.Right inner class.

A set of standard rights are predefined (see RFC 2086). Most folder implementations are expected to support these rights. Some implementations may also support site-defined rights.

The following code sample illustrates how to examine your rights for a folder.


 Rights rights = folder.myRights();

 // Check if I can write this folder
 if (rights.contains(Rights.Right.WRITE))
	System.out.println("Can write folder");

 // Now give Joe all my rights, except the ability to write the folder
 rights.remove(Rights.Right.WRITE);
 ACL acl = new ACL("joe", rights);
 folder.setACL(acl);

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Rights.Right This inner class represents an individual right.

Modifier and Type	Field and Description
private boolean[]	rights

Constructor Summary

Access	Constructor and Description
public	Rights() Construct an empty Rights object.
public	Rights(Rights the rights for initialization rights) Construct a Rights object initialized with the given rights.
public	Rights(String the rights for initialization rights) Construct a Rights object initialized with the given rights.
public	Rights(Rights.Right the right for initialization right) Construct a Rights object initialized with the given right.

Method Summary

Modifier and Type	Method and Description
public void	add(Rights.Right the right to add right) Add the specified right to this Rights object.
public void	add(Rights Rights object rights) Add all the rights in the given Rights object to this Rights object.
public Object	clone() Overrides java.lang.Object.clone. Returns a clone of this Rights object.
public boolean	Returns: true of the given right is present, otherwise false. contains(Rights.Right the Right to check right) Check whether the specified right is present in this Rights object.
public boolean	Returns: true if all rights in the given Rights object are present, otherwise false. contains(Rights the Rights to check rights) Check whether all the rights in the specified Rights object are present in this Rights object.
public boolean	Returns: true if they're equal equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Check whether the two Rights objects are equal.
public Rights.Right[]	Returns: array of Rights.Right objects representing rights getRights() Return all the rights in this Rights object.
public int	Returns: the hash code hashCode() Overrides java.lang.Object.hashCode. Compute a hash code for this Rights object.
public void	remove(Rights.Right the right to be removed right) Remove the specified right from this Rights object.
public void	remove(Rights the rights to be removed rights) Remove all rights in the given Rights object from this Rights object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

rights	back to summary
private boolean[] rights

Constructor Detail

Rights	back to summary
public Rights() Construct an empty Rights object.

Rights	back to summary
public Rights(Rights rights) Construct a Rights object initialized with the given rights. Parameters rights:Rights the rights for initialization

Rights

back to summary

public Rights(Rights rights)

Construct a Rights object initialized with the given rights.

Parameters

rights:Rights: the rights for initialization

Rights	back to summary
public Rights(String rights) Construct a Rights object initialized with the given rights. Parameters rights:String the rights for initialization

Rights

back to summary

public Rights(String rights)

Construct a Rights object initialized with the given rights.

Parameters

rights:String: the rights for initialization

Rights	back to summary
public Rights(Rights.Right right) Construct a Rights object initialized with the given right. Parameters right:Rights.Right the right for initialization

Rights

back to summary

public Rights(Rights.Right right)

Construct a Rights object initialized with the given right.

Parameters

right:Rights.Right: the right for initialization

Method Detail

add	back to summary
public void add(Rights.Right right) Add the specified right to this Rights object. Parameters right:Rights.Right the right to add

add

back to summary

public void add(Rights.Right right)

Add the specified right to this Rights object.

Parameters

right:Rights.Right: the right to add

add	back to summary
public void add(Rights rights) Add all the rights in the given Rights object to this Rights object. Parameters rights:Rights Rights object

add

back to summary

public void add(Rights rights)

Add all the rights in the given Rights object to this Rights object.

Parameters

rights:Rights: Rights object

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Returns a clone of this Rights object. Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Returns a clone of this Rights object.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

contains	back to summary
public boolean contains(Rights.Right right) Check whether the specified right is present in this Rights object. Parameters right:Rights.Right the Right to check Returns:boolean true of the given right is present, otherwise false.

contains

back to summary

public boolean contains(Rights.Right right)

Check whether the specified right is present in this Rights object.

Parameters

right:Rights.Right: the Right to check

Returns:boolean

true of the given right is present, otherwise false.

contains	back to summary
public boolean contains(Rights rights) Check whether all the rights in the specified Rights object are present in this Rights object. Parameters rights:Rights the Rights to check Returns:boolean true if all rights in the given Rights object are present, otherwise false.

contains

back to summary

public boolean contains(Rights rights)

Check whether all the rights in the specified Rights object are present in this Rights object.

Parameters

rights:Rights: the Rights to check

Returns:boolean

true if all rights in the given Rights object are present, otherwise false.

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Check whether the two Rights objects are equal. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean true if they're equal Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Check whether the two Rights objects are equal.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

true if they're equal

Annotations

@Override

getRights	back to summary
public Rights.Right[] getRights() Return all the rights in this Rights object. Returns an array of size zero if no rights are set. Returns:Rights.Right[] array of Rights.Right objects representing rights

getRights

back to summary

public Rights.Right[] getRights()

Return all the rights in this Rights object. Returns an array of size zero if no rights are set.

Returns:Rights.Right[]: array of Rights.Right objects representing rights

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Compute a hash code for this Rights object. Returns:int the hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Compute a hash code for this Rights object.

Returns:int

the hash code

Annotations

@Override

remove	back to summary
public void remove(Rights.Right right) Remove the specified right from this Rights object. Parameters right:Rights.Right the right to be removed

remove

back to summary

public void remove(Rights.Right right)

Remove the specified right from this Rights object.

Parameters

right:Rights.Right: the right to be removed

remove	back to summary
public void remove(Rights rights) Remove all rights in the given Rights object from this Rights object. Parameters rights:Rights the rights to be removed

remove

back to summary

public void remove(Rights rights)

Remove all rights in the given Rights object from this Rights object.

Parameters

rights:Rights: the rights to be removed

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

com.sun.mail.imap back to summary

public final Class Rights.Right

Class Inheritance

extends Object

java.lang.Object
com.sun.mail.imap.Rights.Right

This inner class represents an individual right. A set of standard rights objects are predefined here.

Field Summary

Modifier and Type	Field and Description
public static final Rights.Right	ADMINISTER Administer - perform SETACL.
private static Rights.Right[]	cache
public static final Rights.Right	CREATE Create - CREATE new sub-mailboxes in any implementation-defined hierarchy, RENAME or DELETE mailbox.
public static final Rights.Right	DELETE Delete - STORE \DELETED flag, perform EXPUNGE.
public static final Rights.Right	INSERT Insert - perform APPEND, COPY into mailbox.
public static final Rights.Right	KEEP_SEEN Keep seen/unseen information across sessions - STORE \SEEN flag.
public static final Rights.Right	LOOKUP Lookup - mailbox is visible to LIST/LSUB commands.
public static final Rights.Right	POST Post - send mail to submission address for mailbox, not enforced by IMAP4 itself.
public static final Rights.Right	READ Read - SELECT the mailbox, perform CHECK, FETCH, PARTIAL, SEARCH, COPY from mailbox
pack-priv char	right
public static final Rights.Right	WRITE Write - STORE flags other than \SEEN and \DELETED.

Constructor Summary

Access	Constructor and Description
private	Right(char right) Private constructor used only by getInstance.

Method Summary

Modifier and Type	Method and Description
public static synchronized Rights.Right	Returns: the Right object getInstance(char the character representing the right right) Get a Right object representing the specified character.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

ADMINISTER	back to summary
public static final Rights.Right ADMINISTER Administer - perform SETACL.

cache	back to summary
private static Rights.Right[] cache

CREATE	back to summary
public static final Rights.Right CREATE Create - CREATE new sub-mailboxes in any implementation-defined hierarchy, RENAME or DELETE mailbox.

DELETE	back to summary
public static final Rights.Right DELETE Delete - STORE \DELETED flag, perform EXPUNGE.

INSERT	back to summary
public static final Rights.Right INSERT Insert - perform APPEND, COPY into mailbox.

KEEP_SEEN	back to summary
public static final Rights.Right KEEP_SEEN Keep seen/unseen information across sessions - STORE \SEEN flag.

LOOKUP	back to summary
public static final Rights.Right LOOKUP Lookup - mailbox is visible to LIST/LSUB commands.

POST	back to summary
public static final Rights.Right POST Post - send mail to submission address for mailbox, not enforced by IMAP4 itself.

READ	back to summary
public static final Rights.Right READ Read - SELECT the mailbox, perform CHECK, FETCH, PARTIAL, SEARCH, COPY from mailbox

right	back to summary
pack-priv char right

WRITE	back to summary
public static final Rights.Right WRITE Write - STORE flags other than \SEEN and \DELETED.

Constructor Detail

Right	back to summary
private Right(char right) Private constructor used only by getInstance.

Method Detail

getInstance	back to summary
public static synchronized Rights.Right getInstance(char right) Get a Right object representing the specified character. Characters are assigned per RFC 2086. Parameters right:char the character representing the right Returns:Rights.Right the Right object

getInstance

back to summary

public static synchronized Rights.Right getInstance(char right)

Get a Right object representing the specified character. Characters are assigned per RFC 2086.

Parameters

right:char: the character representing the right

Returns:Rights.Right

the Right object

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations