|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.subject.provider.BaseSourceAdapter
edu.internet2.middleware.grouper.subj.InternalSourceAdapter
public class InternalSourceAdapter
Internal SourceAdapter for retrieving InternalSubjects.
This subject adapter resolves two subjects:
| Field Summary | |
|---|---|
static java.lang.String |
ID
|
static java.lang.String |
NAME
|
| Method Summary | |
|---|---|
void |
checkConfig()
|
edu.internet2.middleware.subject.Subject |
getSubject(java.lang.String id)
Deprecated. |
edu.internet2.middleware.subject.Subject |
getSubject(java.lang.String id,
boolean exceptionIfNull)
Gets a Subject by its ID. |
edu.internet2.middleware.subject.Subject |
getSubjectByIdentifier(java.lang.String id)
Deprecated. |
edu.internet2.middleware.subject.Subject |
getSubjectByIdentifier(java.lang.String id,
boolean exceptionIfNull)
Gets a Subject by other well-known identifiers, aside from the subject ID. |
java.util.Set |
getSubjectTypes()
Gets the SubjectTypes supported by this source. |
void |
init()
Called by SourceManager when it loads this source. |
static InternalSourceAdapter |
instance()
singleton |
java.lang.String |
printConfig()
|
java.util.Set |
search(java.lang.String searchValue)
Unstructured search for Subjects. |
| Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter |
|---|
addAttribute, addInitParam, addInternalAttribute, addSubjectType, equals, getId, getInitParam, getInitParams, getInternalAttributes, getName, getSearchAttributes, getSortAttributes, getSubjectByIdOrIdentifier, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectStatusConfig, getSubjectType, hashCode, loadSearch, removeInitParam, resultSetLimit, searchPage, setId, setName, setSearchAttributes, setSortAttributes |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String ID
public static final java.lang.String NAME
| Method Detail |
|---|
public static InternalSourceAdapter instance()
@Deprecated
public edu.internet2.middleware.subject.Subject getSubject(java.lang.String id)
throws edu.internet2.middleware.subject.SubjectNotFoundException
// Return a subject with the id john.
SourceAdapter sa = new InternalSourceAdapter();
Subject subj = sa.getSubject("john");
getSubject in interface edu.internet2.middleware.subject.SourcegetSubject in class edu.internet2.middleware.subject.provider.BaseSourceAdapterid - Subject id to return.
edu.internet2.middleware.subject.SubjectNotFoundException
public edu.internet2.middleware.subject.Subject getSubject(java.lang.String id,
boolean exceptionIfNull)
throws edu.internet2.middleware.subject.SubjectNotFoundException
// Return a subject with the id john.
SourceAdapter sa = new InternalSourceAdapter();
Subject subj = sa.getSubject("john");
getSubject in interface edu.internet2.middleware.subject.SourcegetSubject in class edu.internet2.middleware.subject.provider.BaseSourceAdapterid - Subject id to return.exceptionIfNull -
edu.internet2.middleware.subject.SubjectNotFoundException
@Deprecated
public edu.internet2.middleware.subject.Subject getSubjectByIdentifier(java.lang.String id)
throws edu.internet2.middleware.subject.SubjectNotFoundException
// Return a subject with the identity john.
SourceAdapter sa = new InternalSourceAdapter();
Subject subj = sa.getSubjectByIdentifier("john");
getSubjectByIdentifier in interface edu.internet2.middleware.subject.SourcegetSubjectByIdentifier in class edu.internet2.middleware.subject.provider.BaseSourceAdapterid - Identity of subject to return.
edu.internet2.middleware.subject.SubjectNotFoundException
public edu.internet2.middleware.subject.Subject getSubjectByIdentifier(java.lang.String id,
boolean exceptionIfNull)
throws edu.internet2.middleware.subject.SubjectNotFoundException
// Return a subject with the identity john.
SourceAdapter sa = new InternalSourceAdapter();
Subject subj = sa.getSubjectByIdentifier("john");
getSubjectByIdentifier in interface edu.internet2.middleware.subject.SourcegetSubjectByIdentifier in class edu.internet2.middleware.subject.provider.BaseSourceAdapterid - Identity of subject to return.exceptionIfNull - SubjectNotFoundException exception if null result
edu.internet2.middleware.subject.SubjectNotFoundExceptionpublic java.util.Set getSubjectTypes()
SourceAdapter sa = new InternalSourceAdapter(); Set types = sa.getSubjectTypes();
getSubjectTypes in interface edu.internet2.middleware.subject.SourcegetSubjectTypes in class edu.internet2.middleware.subject.provider.BaseSourceAdapterpublic void init()
// Initialize this source adapter. SourceAdapter sa = new InternalSourceAdapter(); sa.init();
init in interface edu.internet2.middleware.subject.Sourceinit in class edu.internet2.middleware.subject.provider.BaseSourceAdapterpublic java.util.Set search(java.lang.String searchValue)
// Search for subjects with the query string test.
SourceAdapter sa = new InternalSourceAdapter();
Set subjects = sa.searchValue("test");
search in interface edu.internet2.middleware.subject.Sourcesearch in class edu.internet2.middleware.subject.provider.BaseSourceAdaptersearchValue - Query string for finding subjects.
public void checkConfig()
Source.checkConfig()public java.lang.String printConfig()
Source.printConfig()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||