Package edu.internet2.middleware.grouper

package edu.internet2.middleware.grouper

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

Version:

1.1.0

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

Class	Description
Attribute	Basic Hibernate Attribute DTO interface.
Composite	A composite membership definition within the Groups Registry.
CompositeFinder	Use this class to find a composite
CompositeSave	Use this class to insert or update or delete a composite
Field	Schema specification for a Group attribute or list.
FieldFinder	Find fields.
FieldType	Field Type.
Group	A group within the Groups Registry.
GroupCopy	Use this class to copy a group to another stem.
GrouperAccessAdapter	Grouper Access Privilege interface.
GrouperAPI	Base Grouper API class.
GrouperNamingAdapter	Default implementation of the Grouper NamingPrivilege interface.
GrouperSession	Context for interacting with the Grouper API and Groups Registry.
GrouperSourceAdapter	Source adapter for using Grouper groups as I2MI Subjects.
GroupFinder	Use this class to find groups within the Groups registry
GroupMove	Use this class to move a group to another stem.
GroupSave	The GroupSave class is the recommended and support way to insert/update/delete a group.
GroupType	Schema specification for a Group type.
GroupTypeFinder	Find group types.
GroupTypeTuple	Basic Hibernate Group and GroupType tuple DTO implementation.
Member	A member within the Groups Registry.
MemberFinder	Use this class to find members within the Groups registry
Membership	A list membership in the Groups Registry.
MembershipFinder	Use this class to find memberships within the Groups registry
MembershipSave	Use this class to insert or update or delete a membership
PrivilegeAttributeDefInheritanceSave	Use this class to add/edit/delete privileges on attribute defs inside a folder for a subject
PrivilegeGroupInheritanceSave	Use this class to add/edit/delete privileges on groups inside a folder for a subject
PrivilegeGroupSave	Use this class to insert or update a group privilege
PrivilegeStemInheritanceSave	Use this class to add/edit/delete privileges on folders inside a folder for a subject
PrivilegeStemSave	Use this class to insert or update a stem privilege
RegistrySubject	A Subject local to the Groups Registry.
RegistrySubjectAttribute	Hibernate representation of the JDBC SubjectAttribute table.
Stem	A namespace within the Groups Registry.
Stem.Scope	Search scope: one-level or subtree.
Stem.StemObliterateResults	counts when obliterating or seeing if can obliterate
StemCopy	Use this class to copy a stem to another stem.
StemFinder	Use this class to find stems within the registry
StemMove	Use this class to move a stem to another stem.
StemSave	Use this class to insert or update a stem
SubjectFinder	Use this class to find subjects
SubjectFinder.RestrictSourceForGroup	result to see if source if restricted by group