gov.bnl.gums.db
Interface UserGroupDB

All Known Implementing Classes:

HibernateUserGroupDB, LDAPUserGroupDB

public interface UserGroupDB

A persistance layer for a group of users, used to cache user information on the GUMS server/site instead of taking it always directly from the source. A list of users from a VO will be taken typically few times a day, through the updateMembers() in the group. The UserGroup will typically save the information somewhere. This interface is provided to allow for the cache to reside on different mediums (i.e. Database, LDAP, file, ...)

Author:

Gabriele Carcassi, Jay Packard

Method Summary

boolean	isMemberInGroup(GridUser user) Determines whether a member is in the group.
void	loadUpdatedList(java.util.List members) Sets the list of members as the one given.
java.util.List	retrieveMembers() Retrieves all the members of the griven group.
java.util.List	retrieveNewMembers() Returns the members added after a loadUpdatedList
java.util.List	retrieveRemovedMembers() Returns the members removed after a loadUpdatedList

Method Detail

retrieveMembers

java.util.List retrieveMembers()

Retrieves all the members of the griven group.

Returns:

A List of GridUser objects representing all the members in the group.

isMemberInGroup

boolean isMemberInGroup(GridUser user)

Determines whether a member is in the group. It must be a direct query to the store, not on a cached value.

Parameters:

user - A grid credential

Returns:

True if the credential was in the list of members

loadUpdatedList

void loadUpdatedList(java.util.List members)

Sets the list of members as the one given. The method should change what was stored to the content of the list. It should also perform a diff, so that calls to retrieveNewMembers and retrieveRemovedMembers will return the changes.

Parameters:

members - A list of GridUser objects.

retrieveNewMembers

java.util.List retrieveNewMembers()

Returns the members added after a loadUpdatedList

Returns:

A list of GridUser objects.

retrieveRemovedMembers

java.util.List retrieveRemovedMembers()

Returns the members removed after a loadUpdatedList

Returns:

A list of GridUser objects.