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

Class EveryonePrincipal

java.lang.Object

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

All Implemented Interfaces:

java.security.acl.Group, java.security.Principal, GroupPrincipal, JackrabbitPrincipal

public final class EveryonePrincipal
extends java.lang.Object
implements JackrabbitPrincipal, java.security.acl.Group, GroupPrincipal

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal

implies

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getInstance

public static EveryonePrincipal getInstance()

getName

public java.lang.String getName()

Specified by:

getName in interface java.security.Principal

addMember

public boolean addMember(java.security.Principal user)

Specified by:

addMember in interface java.security.acl.Group

removeMember

public boolean removeMember(java.security.Principal user)

Specified by:

removeMember in interface java.security.acl.Group

isMember

public boolean isMember(@NotNull
                        @NotNull java.security.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 java.security.acl.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

@NotNull
public @NotNull java.util.Enumeration<? extends java.security.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 java.security.acl.Group

Specified by:

members in interface GroupPrincipal

Returns:

an enumeration of the group members.

hashCode

public int hashCode()

Specified by:

hashCode in interface java.security.Principal

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.security.Principal

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface java.security.Principal

Overrides:

toString in class java.lang.Object