edu.internet2.middleware.grouper

Class GrouperSourceAdapter

java.lang.Object

edu.internet2.middleware.subject.provider.BaseSourceAdapter

edu.internet2.middleware.grouper.GrouperSourceAdapter

All Implemented Interfaces:

Source

Direct Known Subclasses:

EntitySourceAdapter

public class GrouperSourceAdapter
extends BaseSourceAdapter

Source adapter for using Grouper groups as I2MI Subjects.

This is an adapter I2MI Subjects of type group. It allows groups within a Group Groups Registry to be referenced as I2MI Subjects.

To use, add the following to your subject.properties file:

 <source adapterClass="edu.internet2.middleware.grouper.GrouperSourceAdapter">
   <id>g:gsa</id>
   <name>Grouper: Grouper Source Adapter</name>
   <type>group</type>
 </source>
 

Version:

$Id: GrouperSourceAdapter.java,v 1.31 2009-08-12 04:52:21 mchyzer Exp $

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	failOnSearchForTesting for testing if we should fail on testing

Fields inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter

attributes, descriptionAttributeName, id, internalAttributes, name, nameAttributeName, params, searchAttributes, searches, sortAttributes, subjectIdentifierAttributes, subjectIdentifierAttributesAll, type, types

Constructor Summary

Constructors

Constructor and Description
GrouperSourceAdapter() Allocates new GrouperSourceAdapter.
GrouperSourceAdapter(String id, String name) Allocates new GrouperSourceAdapter.

Method Summary

Modifier and Type	Method and Description
void	checkConfig() make sure the config is ok, and log descriptive errors if not
static void	clearSearchForGroupsWithReadPrivilege() put this in a finally block to clear that we are searching for groups with certain privileges
Integer	getMaxPage() max Page size
Subject	getSubject(String id) Deprecated.
Subject	getSubject(String id, boolean exceptionIfNotFound) Get a Group subject by UUID.
Subject	getSubjectByIdentifier(String name) Deprecated.
Subject	getSubjectByIdentifier(String name, boolean exceptionIfNull) Gets a Group subject by its name.
Map<Integer,String>	getSubjectIdentifierAttributes() Get the names of attributes that are subject identifiers.
Map<String,Subject>	getSubjectsByIdentifiers(Collection<String> identifiers) Get subjects by identifiers.
Map<String,Subject>	getSubjectsByIds(Collection<String> ids) Get subjects by ids.
Set	getSubjectTypes() Gets the SubjectTypes supported by this source.
static String	groupSourceId() return the group source id
void	init() Initializes the Grouper source adapter.
static GrouperSession	internal_getSessionOrRootForSubjectFinder()
void	loggingStart() start logging the source low level actions
String	loggingStop() stop logging and get the output
String	printConfig() in the startup on this i2mi app, print helpful and brief info about this source
Set<String>	retrieveAllSubjectIds() get all subject ids
Set<Subject>	search(String searchValue) Unstructured search for Subjects.
static boolean	searchForGroupsWithReadPrivilege() if searching for groups with read privilege
static void	searchForGroupsWithReadPrivilege(boolean searchForRead) when doing a subject search, search for groups with privileges
SearchPageResult	searchPage(String searchValue) Unstructured search for Subjects.
Set<TypeOfGroup>	typeOfGroups() type of groups to search on

Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter

addAttribute, addInitParam, addInternalAttribute, addSubjectType, convertSourceAttributeToSubjectAttribute, convertSubjectAttributeToSourceAttribute, createSubject, equals, getAttributes, getConfigId, getId, getInitParam, getInternalAttributes, getName, getSearch, getSearchAttributes, getSearches, getSortAttributes, getSourceAttributesToLowerCase, getSubject, getSubjectByIdentifier, getSubjectByIdOrIdentifier, getSubjectByIdOrIdentifier, getSubjectIdentifierAttributesAll, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectsByIdsOrIdentifiers, getSubjectStatusConfig, getSubjectType, hashCode, initParams, isEditable, isEnabled, loadSearch, removeInitParam, resultSetLimit, search, searchPage, setConfigId, setId, setName, setSearchAttributes, setSearches, setSortAttributes, setSubjectIdentifierAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

failOnSearchForTesting

public static boolean failOnSearchForTesting

for testing if we should fail on testing

Constructor Detail

GrouperSourceAdapter

public GrouperSourceAdapter()

Allocates new GrouperSourceAdapter.

GrouperSourceAdapter

public GrouperSourceAdapter(String id,
                            String name)

Allocates new GrouperSourceAdapter.

Parameters:

id -

name -

Method Detail

loggingStart

public void loggingStart()

Description copied from interface: Source

start logging the source low level actions

loggingStop

public String loggingStop()

Description copied from interface: Source

stop logging and get the output

retrieveAllSubjectIds

public Set<String> retrieveAllSubjectIds()

Description copied from interface: Source

get all subject ids

Specified by:

retrieveAllSubjectIds in interface Source

Overrides:

retrieveAllSubjectIds in class BaseSourceAdapter

Returns:

all subjectIds

See Also:

BaseSourceAdapter.retrieveAllSubjectIds()

searchForGroupsWithReadPrivilege

public static void searchForGroupsWithReadPrivilege(boolean searchForRead)

when doing a subject search, search for groups with privileges

Parameters:

privileges1 -

searchForGroupsWithReadPrivilege

public static boolean searchForGroupsWithReadPrivilege()

if searching for groups with read privilege

Returns:

if searching

clearSearchForGroupsWithReadPrivilege

public static void clearSearchForGroupsWithReadPrivilege()

put this in a finally block to clear that we are searching for groups with certain privileges

getSubject

@Deprecated
public Subject getSubject(String id)
                               throws SubjectNotFoundException

Deprecated.

Get a Group subject by UUID.

 // Use it within the Grouper API
 try {
   Subject subj = SubjectFinder.getSubject(uuid, "group");
 } 
 catch (SubjectNotFoundException e) {
   // Subject not found
 }

 // Use it directly
 try {
   Subject subj = source.getSubject(uuid, "group");
 } 
 catch (SubjectNotFoundException e) {
   // Subject not found
 }
 

Specified by:

getSubject in interface Source

Specified by:

getSubject in class BaseSourceAdapter

Parameters:

id - Group UUID

Returns:

A Subject

Throws:

SubjectNotFoundException

See Also:

Source.getSubject(java.lang.String)

getSubject

public Subject getSubject(String id,
                          boolean exceptionIfNotFound)
                   throws SubjectNotFoundException

Get a Group subject by UUID.

 // Use it within the Grouper API
 try {
   Subject subj = SubjectFinder.getSubject(uuid, "group");
 } 
 catch (SubjectNotFoundException e) {
   // Subject not found
 }

 // Use it directly
 try {
   Subject subj = source.getSubject(uuid, "group");
 } 
 catch (SubjectNotFoundException e) {
   // Subject not found
 }
 

Specified by:

getSubject in interface Source

Overrides:

getSubject in class BaseSourceAdapter

Parameters:

id - Group UUID

exceptionIfNotFound -

Returns:

A Subject

Throws:

SubjectNotFoundException

See Also:

Source.getSubject(java.lang.String, boolean)

getSubjectByIdentifier

@Deprecated
public Subject getSubjectByIdentifier(String name)
                                           throws SubjectNotFoundException

Deprecated.

Gets a Group subject by its name.

 // Use it within the Grouper API
 try {
   Subject subj = SubjectFinder.getSubjectByIdentifier(name, "group");
 }
 catch (SubjectNotFoundException e) {
   // Subject not found
 }

 // Use it directly
 try {
   Subject subj = source.getSubjectByIdentifier(name, "group");
 } 
 catch (SubjectNotFoundException e) {
   // Subject not found
 }
 

Specified by:

getSubjectByIdentifier in interface Source

Specified by:

getSubjectByIdentifier in class BaseSourceAdapter

Parameters:

name - Group name

Returns:

A Subject

Throws:

SubjectNotFoundException

See Also:

Source.getSubjectByIdentifier(java.lang.String)

getSubjectsByIdentifiers

public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)

Description copied from interface: Source

Get subjects by identifiers. Note, if the subjects arent found or arent unique, they wont be returned. Identifiers are unique ways to refer to a subject that isnt its id (e.g. netid). Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIdentifiers in interface Source

Overrides:

getSubjectsByIdentifiers in class BaseSourceAdapter

Returns:

a map of results never null indexed by the identifiers

See Also:

Source.getSubjectsByIdentifiers(Collection)

getSubjectsByIds

public Map<String,Subject> getSubjectsByIds(Collection<String> ids)

Description copied from interface: Source

Get subjects by ids. Note, if the subjects arent found or arent unique, they wont be returned. Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIds in interface Source

Overrides:

getSubjectsByIds in class BaseSourceAdapter

Returns:

a map of results never null indexed by the id

See Also:

Source.getSubjectsByIds(Collection)

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String name,
                                      boolean exceptionIfNull)
                               throws SubjectNotFoundException

Gets a Group subject by its name.

 // Use it within the Grouper API
 try {
   Subject subj = SubjectFinder.getSubjectByIdentifier(name, "group");
 }
 catch (SubjectNotFoundException e) {
   // Subject not found
 }

 // Use it directly
 try {
   Subject subj = source.getSubjectByIdentifier(name, "group");
 } 
 catch (SubjectNotFoundException e) {
   // Subject not found
 }
 

Specified by:

getSubjectByIdentifier in interface Source

Overrides:

getSubjectByIdentifier in class BaseSourceAdapter

Parameters:

name - Group name

exceptionIfNull -

Returns:

A Subject

Throws:

SubjectNotFoundException

See Also:

Source.getSubjectByIdentifier(java.lang.String, boolean)

getSubjectTypes

public Set getSubjectTypes()

Gets the SubjectTypes supported by this source.

 SourceAdapter  sa    = new GrouperSourceAdapter();
 Set            types = sa.getSubjectTypes();
 

Specified by:

getSubjectTypes in interface Source

Overrides:

getSubjectTypes in class BaseSourceAdapter

Returns:

Subject types supported by this source.

init

public void init()
          throws SourceUnavailableException

Initializes the Grouper source adapter.

No initialization is currently performed by this adapter.

Specified by:

init in interface Source

Specified by:

init in class BaseSourceAdapter

Throws:

SourceUnavailableException

groupSourceId

public static String groupSourceId()

return the group source id

Returns:

the source id for the group source

typeOfGroups

public Set<TypeOfGroup> typeOfGroups()

type of groups to search on

Returns:

type of groups

internal_getSessionOrRootForSubjectFinder

public static GrouperSession internal_getSessionOrRootForSubjectFinder()

Returns:

session

checkConfig

public void checkConfig()

Description copied from interface: Source

make sure the config is ok, and log descriptive errors if not

See Also:

Source.checkConfig()

printConfig

public String printConfig()

Description copied from interface: Source

in the startup on this i2mi app, print helpful and brief info about this source

Returns:

the info

See Also:

Source.printConfig()

getMaxPage

public Integer getMaxPage()

max Page size

Returns:

the maxPage

search

public Set<Subject> search(String searchValue)

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions

Specified by:

search in interface Source

Specified by:

search in class BaseSourceAdapter

Returns:

set

searchPage

public SearchPageResult searchPage(String searchValue)

Description copied from interface: Source

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions if maxPageSize is set in subject.properties, then only return max that many, and if there are more, set the tooManyResults flag

Specified by:

searchPage in interface Source

Overrides:

searchPage in class BaseSourceAdapter

Returns:

results and if there are too many, never return null!!!

See Also:

BaseSourceAdapter.searchPage(java.lang.String)

getSubjectIdentifierAttributes

public Map<Integer,String> getSubjectIdentifierAttributes()

Description copied from interface: Source

Get the names of attributes that are subject identifiers. This only returns the first

Specified by:

getSubjectIdentifierAttributes in interface Source

Overrides:

getSubjectIdentifierAttributes in class BaseSourceAdapter

Returns:

subject identifiers

See Also:

Source.getSubjectIdentifierAttributes()