edu.internet2.middleware.grouper.subj

Class InternalSourceAdapter

java.lang.Object

edu.internet2.middleware.subject.provider.BaseSourceAdapter

edu.internet2.middleware.grouper.subj.InternalSourceAdapter

All Implemented Interfaces:

Source

public class InternalSourceAdapter
extends BaseSourceAdapter

Internal SourceAdapter for retrieving InternalSubjects.

This subject adapter resolves two subjects:

• GrouperAll
• GrouperSystem

Version:

$Id: InternalSourceAdapter.java,v 1.6 2009-09-02 05:57:26 mchyzer Exp $

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
static String	NAME

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
InternalSourceAdapter() Allocates new InternalSourceAdapter.

Method Summary

Modifier and Type	Method and Description
void	checkConfig() make sure the config is ok, and log descriptive errors if not
String	getRootName()
Subject	getSubject(String id) Deprecated.
Subject	getSubject(String id, boolean exceptionIfNull) Gets a Subject by its ID.
Subject	getSubjectByIdentifier(String id) Deprecated.
Subject	getSubjectByIdentifier(String id, boolean exceptionIfNull) Gets a Subject by other well-known identifiers, aside from the subject ID.
Set	getSubjectTypes() Gets the SubjectTypes supported by this source.
void	init() Called by SourceManager when it loads this source.
static InternalSourceAdapter	instance() singleton
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
boolean	rootSubject(Subject subject) if root subject
Set	search(String searchValue) Unstructured search for Subjects.

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, getSubjectIdentifierAttributes, getSubjectIdentifierAttributesAll, getSubjectsByIdentifiers, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectsByIdsOrIdentifiers, getSubjectStatusConfig, getSubjectType, hashCode, initParams, isEditable, isEnabled, loadSearch, removeInitParam, resultSetLimit, retrieveAllSubjectIds, search, searchPage, 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

ID

public static final String ID

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

InternalSourceAdapter

public InternalSourceAdapter()

Allocates new InternalSourceAdapter.

 InternalSourceAdapter msa = new InternalSourceAdapter();
 

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

instance

public static InternalSourceAdapter instance()

singleton

Returns:

the singleton

getSubject

@Deprecated
public Subject getSubject(String id)
                               throws SubjectNotFoundException

Deprecated.

Gets a Subject by its ID.

 // Return a subject with the id john.
 SourceAdapter  sa    = new InternalSourceAdapter();
 Subject        subj  = sa.getSubject("john");
 

Specified by:

getSubject in interface Source

Specified by:

getSubject in class BaseSourceAdapter

Parameters:

id - Subject id to return.

Returns:

An internal subject.

Throws:

SubjectNotFoundException

See Also:

Source.getSubject(java.lang.String)

getSubject

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

Gets a Subject by its ID.

 // Return a subject with the id john.
 SourceAdapter  sa    = new InternalSourceAdapter();
 Subject        subj  = sa.getSubject("john");
 

Specified by:

getSubject in interface Source

Overrides:

getSubject in class BaseSourceAdapter

Parameters:

id - Subject id to return.

exceptionIfNull -

Returns:

An internal subject.

Throws:

SubjectNotFoundException

See Also:

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

getSubjectByIdentifier

@Deprecated
public Subject getSubjectByIdentifier(String id)
                                           throws SubjectNotFoundException

Deprecated.

Gets a Subject by other well-known identifiers, aside from the subject ID.

 // Return a subject with the identity john.
 SourceAdapter  sa    = new InternalSourceAdapter();
 Subject        subj  = sa.getSubjectByIdentifier("john");
 

Specified by:

getSubjectByIdentifier in interface Source

Specified by:

getSubjectByIdentifier in class BaseSourceAdapter

Parameters:

id - Identity of subject to return.

Returns:

An internal subject.

Throws:

SubjectNotFoundException

See Also:

Source.getSubjectByIdentifier(java.lang.String)

getSubjectByIdentifier

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

Gets a Subject by other well-known identifiers, aside from the subject ID.

 // Return a subject with the identity john.
 SourceAdapter  sa    = new InternalSourceAdapter();
 Subject        subj  = sa.getSubjectByIdentifier("john");
 

Specified by:

getSubjectByIdentifier in interface Source

Overrides:

getSubjectByIdentifier in class BaseSourceAdapter

Parameters:

id - Identity of subject to return.

exceptionIfNull - SubjectNotFoundException exception if null result

Returns:

An internal 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 InternalSourceAdapter();
 Set            types = sa.getSubjectTypes();
 

Specified by:

getSubjectTypes in interface Source

Overrides:

getSubjectTypes in class BaseSourceAdapter

Returns:

Subject type supported by this source.

init

public void init()

Called by SourceManager when it loads this source.

 // Initialize this source adapter.
 SourceAdapter sa = new InternalSourceAdapter();
 sa.init();
 

Specified by:

init in interface Source

Specified by:

init in class BaseSourceAdapter

search

public Set search(String searchValue)

Unstructured search for Subjects.

 // Search for subjects with the query string test.
 SourceAdapter  sa        = new InternalSourceAdapter();
 Set            subjects  = sa.searchValue("test");
 

Specified by:

search in interface Source

Specified by:

search in class BaseSourceAdapter

Parameters:

searchValue - Query string for finding subjects.

Returns:

Subjects matching search value.

rootSubject

public boolean rootSubject(Subject subject)

if root subject

Parameters:

subject -

Returns:

if root

getRootName

public String getRootName()

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()