gov.nih.nci.cagrid.gridgrouper.grouper
Interface GrouperI

All Known Implementing Classes:

GridGrouper

public interface GrouperI

Version:

$Id: GridGrouperBaseTreeNode.java,v 1.1 2006/08/04 03:49:26 langella Exp $

Author:

Stephen Langella, Scott Oster, Shannon Hastings, David W. Ervin

Method Summary

GroupI	findGroup(java.lang.String name) Obtains the Group object for a specified Group.
StemI	findStem(java.lang.String name) Obtains the Stem object for a specified Stem.
java.lang.String	getName() Obtains the name of the Grid Grouper, generally the Grid Grouper service URI.
StemI	getRootStem() Returns a Stem object corresponding to the Grid Grouper root stem.
boolean	isMemberOf(java.lang.String subjectId, java.lang.String groupName) Determines whether or not a subject is a member of a group.
boolean	isMemberOf(edu.internet2.middleware.subject.Subject subject, java.lang.String groupName) Determines whether or not a subject is a member of a group.

Method Detail

getRootStem

StemI getRootStem()
                  throws edu.internet2.middleware.grouper.StemNotFoundException

Returns a Stem object corresponding to the Grid Grouper root stem.

Returns:

Stem object corresponding to the Grid Grouper root stem.

Throws:

edu.internet2.middleware.grouper.StemNotFoundException - Thrown if the root stem could not be found.

findStem

StemI findStem(java.lang.String name)
               throws edu.internet2.middleware.grouper.StemNotFoundException

Obtains the Stem object for a specified Stem.

Parameters:

name - The name of the stem

Returns:

The Stem Object or the requested stem.

Throws:

edu.internet2.middleware.grouper.StemNotFoundException - Thrown if the request stem could not be found.

getName

java.lang.String getName()

Obtains the name of the Grid Grouper, generally the Grid Grouper service URI.

Returns:

The name of the Grid Grouper service.

findGroup

GroupI findGroup(java.lang.String name)
                 throws edu.internet2.middleware.grouper.GroupNotFoundException

Obtains the Group object for a specified Group.

Parameters:

name - The name of the group.

Returns:

The Group Object or the requested stem.

Throws:

edu.internet2.middleware.grouper.GroupNotFoundException - Thrown if the request group could not be found.

isMemberOf

boolean isMemberOf(java.lang.String subjectId,
                   java.lang.String groupName)
                   throws edu.internet2.middleware.grouper.GroupNotFoundException

Determines whether or not a subject is a member of a group.

Parameters:

subjectId - The id of the subject.

groupName - The name of the group.

Returns:

True if member

Throws:

edu.internet2.middleware.grouper.GroupNotFoundException - Thrown if the request group could not be found.

isMemberOf

boolean isMemberOf(edu.internet2.middleware.subject.Subject subject,
                   java.lang.String groupName)
                   throws edu.internet2.middleware.grouper.GroupNotFoundException

Determines whether or not a subject is a member of a group.

Parameters:

subject - The subject.

groupName - The name of the group.

Returns:

Returns true if the subject is a member of the group, or false if the user is not a member of the group.

Throws:

edu.internet2.middleware.grouper.GroupNotFoundException - Thrown if the request group could not be found.