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

Class GroupPrincipals

java.lang.Object

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

public final class GroupPrincipals
extends Object

Helper class to deal with the migration between the 2 types of groups

Method Summary

Modifier and Type	Method and Description
static boolean	isGroup(@NotNull Principal principal) Checks if the provided principal is a group.
static boolean	isMember(@NotNull Principal principal, @NotNull Principal member) Returns true if the passed principal is a member of the group.
static @NotNull Enumeration<? extends Principal>	members(@NotNull Principal principal) Returns an enumeration of the members in the group.

Methods inherited from class java.lang.Object

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

Method Detail

isGroup

public static boolean isGroup(@NotNull
                              @NotNull Principal principal)

Checks if the provided principal is a group.

Parameters:

principal - to be checked.

Returns:

true if the principal is of type group.

members

@NotNull
public static @NotNull Enumeration<? extends Principal> members(@NotNull
                                                                         @NotNull Principal principal)

Returns an enumeration of the members in the group.

Parameters:

principal - the principal whose membership is listed.

Returns:

an enumeration of the group members.

isMember

public static boolean isMember(@NotNull
                               @NotNull Principal principal,
                               @NotNull
                               @NotNull Principal member)

Returns true if the passed principal is a member of the group.

Parameters:

principal - the principal whose members are being checked.

member - the principal whose membership is to be checked.

Returns:

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