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

Interface DynamicMembershipProvider

public interface DynamicMembershipProvider

Field Summary

Fields

Modifier and Type	Field	Description
static DynamicMembershipProvider	EMPTY

Method Summary

Modifier and Type	Method	Description
boolean	coversAllMembers(@NotNull org.apache.jackrabbit.api.security.user.Group group)	Returns true if this implementation of DynamicMembershipProvider covers all members for the given Group making it a fully dynamic group.
@NotNull java.util.Iterator<org.apache.jackrabbit.api.security.user.Authorizable>	getMembers(@NotNull org.apache.jackrabbit.api.security.user.Group group, boolean includeInherited)	Returns the dynamic members for the given group.
@NotNull java.util.Iterator<org.apache.jackrabbit.api.security.user.Group>	getMembership(@NotNull org.apache.jackrabbit.api.security.user.Authorizable authorizable, boolean includeInherited)	Returns an iterator over all groups the given authorizable is a dynamic member of.
boolean	isMember(@NotNull org.apache.jackrabbit.api.security.user.Group group, @NotNull org.apache.jackrabbit.api.security.user.Authorizable authorizable, boolean includeInherited)	Returns true if the given authorizable is a dynamic member of the given target group.

Field Detail

EMPTY

static final DynamicMembershipProvider EMPTY

Method Detail

coversAllMembers

boolean coversAllMembers(@NotNull
                         @NotNull org.apache.jackrabbit.api.security.user.Group group)

Returns true if this implementation of DynamicMembershipProvider covers all members for the given Group making it a fully dynamic group.

Parameters:

group - The target group

Returns:

true if the provider covers all members of the given target group i.e. making it a fully dynamic group (like for example the 'everyone' group); false otherwise.

getMembers

@NotNull
@NotNull java.util.Iterator<org.apache.jackrabbit.api.security.user.Authorizable> getMembers(@NotNull
                                                                                             @NotNull org.apache.jackrabbit.api.security.user.Group group,
                                                                                             boolean includeInherited)
                                                                                      throws RepositoryException

Returns the dynamic members for the given group.

Parameters:

group - The target group.

includeInherited - If true inherited members should be included in the resulting iterator.

Returns:

An iterator of user/groups that are dynamic members of the given target group.

Throws:

RepositoryException - If an error occurs.

isMember

boolean isMember(@NotNull
                 @NotNull org.apache.jackrabbit.api.security.user.Group group,
                 @NotNull
                 @NotNull org.apache.jackrabbit.api.security.user.Authorizable authorizable,
                 boolean includeInherited)
          throws RepositoryException

Returns true if the given authorizable is a dynamic member of the given target group.

Parameters:

group - The target group.

authorizable - The user/group that may or may not be dynamic member of the given target group.

includeInherited - If set to true inherited group membership will be evaluated.

Returns:

true if the given authorizable is a dynamic member of the given target group.

Throws:

RepositoryException - If an error occurs.

getMembership

@NotNull
@NotNull java.util.Iterator<org.apache.jackrabbit.api.security.user.Group> getMembership(@NotNull
                                                                                         @NotNull org.apache.jackrabbit.api.security.user.Authorizable authorizable,
                                                                                         boolean includeInherited)
                                                                                  throws RepositoryException

Returns an iterator over all groups the given authorizable is a dynamic member of.

Parameters:

authorizable - The target user/group for which to evaluate membership.

includeInherited - If set to true inherited group membership will be included in the result.

Returns:

An iterator over all groups the given authorizable is a dynamic member of.

Throws:

RepositoryException - If an error occurs.