org.apache.jackrabbit.core.security.principal

Class EveryonePrincipal

java.lang.Object

org.apache.jackrabbit.core.security.principal.EveryonePrincipal

All Implemented Interfaces:

Group, Principal, GroupPrincipal, JackrabbitPrincipal

public final class EveryonePrincipal
extends Object
implements Group, GroupPrincipal, JackrabbitPrincipal

The EveryonePrincipal contains all principals (excluding itself).

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Method Summary

Modifier and Type	Method and Description
boolean	addMember(Principal user)
boolean	equals(Object obj)
static EveryonePrincipal	getInstance()
String	getName()
int	hashCode()
boolean	isMember(Principal member) Returns true if the passed principal is a member of the group.
Enumeration<? extends Principal>	members() Returns an enumeration of the members in the group.
boolean	removeMember(Principal user)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies, toString

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Method Detail

getInstance

public static EveryonePrincipal getInstance()

getName

public String getName()

Specified by:

getName in interface Principal

addMember

public boolean addMember(Principal user)

Specified by:

addMember in interface Group

removeMember

public boolean removeMember(Principal user)

Specified by:

removeMember in interface Group

isMember

public boolean isMember(Principal member)

Description copied from interface: GroupPrincipal

Returns true if the passed principal is a member of the group. This method does a recursive search, so if a principal belongs to a group which is a member of this group, true is returned.

Specified by:

isMember in interface Group

Specified by:

isMember in interface GroupPrincipal

Parameters:

member - the principal whose membership is to be checked.

Returns:

true if the principal is a member of this group, false otherwise.

members

public Enumeration<? extends Principal> members()

Description copied from interface: GroupPrincipal

Returns an enumeration of the members in the group. This includes both declared members and all principals that are indirect group members. The returned objects can be instances of either Principal or GroupPrincipal (which is a subclass of Principal).

Specified by:

members in interface Group

Specified by:

members in interface GroupPrincipal

Returns:

an enumeration of the group members.

hashCode

public int hashCode()

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Principal

Overrides:

equals in class Object