de.innovationgate.utils

Class GroupMembershipResolver

java.lang.Object

de.innovationgate.utils.GroupMembershipResolver

public abstract class GroupMembershipResolver
extends java.lang.Object

This abstract class implements the recommended behaviour to resolve hierarchical group membership (groups that themselves maybe members of groups) without determining the functionality for resolving direct group memberships.

The behaviour is:

1. Determine the direct group membership for the member to resolve
2. For each group found determine the direct membership again
3. Remove groups from the result lists that were already resolved
4. If the result list is > 0 start over at point 2 with the new result list
5. If the result list is = 0, resolving is over and return the retrieved groups.

This behaviour is

• a) a very effective way for hierarchical resolving that
• b) is not vulnerable to circular group memberships (a is member of b is member of a and the like)

To use this just

• a) Subclass it
• b) Write resolveDirectMembership(String) to determine direct group membership of the given member
• c) In your code call resolveMembership(String) to determine hierarchical group membership

Constructor Summary

Constructors

Constructor and Description
GroupMembershipResolver()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.util.Set<java.lang.String>	resolveDirectMembership(java.lang.String member) Abstract method to define how direct group membership is determined.
java.util.Set<java.lang.String>	resolveMembership(java.lang.String member) Determine hierarchical group membership of the given member

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupMembershipResolver

public GroupMembershipResolver()

Method Detail

resolveMembership

public java.util.Set<java.lang.String> resolveMembership(java.lang.String member)
                                                  throws GroupResolvingException

Determine hierarchical group membership of the given member

Parameters:

member - The member name whose groups should be determined

Returns:

List of names of those groups that the member name is member of

Throws:

GroupResolvingException

resolveDirectMembership

public abstract java.util.Set<java.lang.String> resolveDirectMembership(java.lang.String member)
                                                                 throws GroupResolvingException

Abstract method to define how direct group membership is determined. Direct group membership is defined as a person/group A being a directly defined member of a group B (in contrary to indirect membership where a person/group A is a member of a group B, because another group C that contains A is a member of B)

Implement your indivual method of determining direct group membership for the given member here. In traditional grouping systems where a group consists only of a list of user/group names as members this would be: Look if the member name is contained in the group members list. If something essential goes wrong in your code throw a GroupResolvingException.

Parameters:

member - The member name to determine direct group membership for

Returns:

A set of names of those groups that the member name is member of

Throws:

GroupResolvingException