Package org.apache.jackrabbit.oak.spi.security.principal

Class EveryonePrincipal

java.lang.Object

org.apache.jackrabbit.oak.spi.security.principal.EveryonePrincipal

All Implemented Interfaces:

Principal, GroupPrincipal, JackrabbitPrincipal

public final class EveryonePrincipal
extends Object
implements JackrabbitPrincipal, GroupPrincipal

Built-in principal group that has every other principal as member.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.security.Principal

implies

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

isMember

public boolean isMember(@NotNull
                        @NotNull 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 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

@NotNull
public @NotNull 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 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

toString

public String toString()

Specified by:

toString in interface Principal

Overrides:

toString in class Object