Skip navigation links

Package edu.internet2.middleware.grouper

The I2MI Grouper project is an open source toolkit for managing groups.

See: Description

Package edu.internet2.middleware.grouper Description

The I2MI Grouper project is an open source toolkit for managing groups.


Grouper API Overview

While there are many public classes within the Grouper API the majority of its functionality can be found in a small subset of its classes. The most important classes to familiarize yourself with are:

  • Group

    As evident by its name, Grouper is all about managing groups. Groups are objects that may have attributes, memberships and privileges assigned to them.

  • Stem

    Stems are namespaces within which groups are located. They make it possible to delegate authority within the Groups Registry.

  • Subject

    This class is actually external to Grouper and is being developed by both the Grouper and Signet projects. It provides an IdM abstraction that allows an application to refer to entities of any type (people, groups, applications, etc.) without needing to be aware of how those entities are accessed or stored. See the Subject API page at the Grouper wiki for more information on the Subject API.

  • SubjectFinder

    This is a class that abstracts finding subjects. With it you can query one-or-more subject repositories in order to retrieve subjects for use within other Grouper API operations.

  • Member

    Members are strictly mappings of subjects to persistent identifiers for those subjects within Grouper. While many API operations require that a Subject be passed as a parameter, internally Grouper works on those subjects as Member objects.

  • Membership

    This class maps how all list values (memberships) are stored within the Groups Registry.

  • GrouperSession

    This class provides an operational and security context for performing operations within the Grouper API. With the exception of SubjectFinder almost all other API operations require a valid session context to operate within. A subject is associated with each session and the privileges of that subject determine what API operations can be performed within the session context.

There is a small - but growing - selection of API usage examples.

This package has the major grouper javabeans (generally mapped to the DB via hibernate), along with "Finders" which are static methods to help query for the beans.

See Also:
Grouper Wiki
Skip navigation links

Copyright © 2016 Internet2. All rights reserved.