|
|||||||||
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.subject.provider.NullSourceAdapter
public class NullSourceAdapter
Null Source
which will never return any Subject
s.
Constructor Summary | |
---|---|
NullSourceAdapter()
Allocates new NullSourceAdapter . |
|
NullSourceAdapter(String id1,
String name1)
Allocates new NullSourceAdapter . |
Method Summary | |
---|---|
void |
checkConfig()
make sure the config is ok, and log descriptive errors if not |
Subject |
getSubject(String id1)
Deprecated. |
Subject |
getSubject(String id1,
boolean exceptionIfNull)
Gets a Subject by its ID. |
Subject |
getSubjectByIdentifier(String id1)
Deprecated. |
Subject |
getSubjectByIdentifier(String id1,
boolean exceptionIfNull)
note, you should implement this method since this implementation will become abstract at some point |
Set<SubjectType> |
getSubjectTypes()
Gets the SubjectTypes supported by this source. |
void |
init()
Called by SourceManager when it loads this source. |
String |
printConfig()
in the startup on this i2mi app, print helpful and brief info about this source |
Set<Subject> |
search(String searchValue)
Unstructured search for Subjects. |
Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter |
---|
addAttribute, addInitParam, addSubjectType, equals, getId, getInitParam, getInitParams, getName, getSubjectByIdOrIdentifier, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectType, hashCode, loadSearch, setId, setName |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NullSourceAdapter()
NullSourceAdapter
.
public NullSourceAdapter(String id1, String name1)
NullSourceAdapter
.
id1
- The source id for the new adapter.name1
- The source name for the new adapter.Method Detail |
---|
public Subject getSubject(String id1, boolean exceptionIfNull) throws SubjectNotFoundException
Source
getSubject
in interface Source
getSubject
in class BaseSourceAdapter
exceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returned
SubjectNotFoundException
BaseSourceAdapter.getSubject(java.lang.String, boolean)
public Subject getSubjectByIdentifier(String id1, boolean exceptionIfNull) throws SubjectNotFoundException
BaseSourceAdapter
getSubjectByIdentifier
in interface Source
getSubjectByIdentifier
in class BaseSourceAdapter
SubjectNotFoundException
BaseSourceAdapter.getSubjectByIdentifier(java.lang.String, boolean)
public Set<SubjectType> getSubjectTypes()
BaseSourceAdapter
getSubjectTypes
in interface Source
getSubjectTypes
in class BaseSourceAdapter
BaseSourceAdapter.getSubjectTypes()
public void init() throws SourceUnavailableException
BaseSourceAdapter
init
in interface Source
init
in class BaseSourceAdapter
SourceUnavailableException
BaseSourceAdapter.init()
public Set<Subject> search(String searchValue)
BaseSourceAdapter
search
in interface Source
search
in class BaseSourceAdapter
BaseSourceAdapter.search(java.lang.String)
public void checkConfig()
Source
Source.checkConfig()
public String printConfig()
Source
Source.printConfig()
@Deprecated public Subject getSubject(String id1) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubject
in interface Source
getSubject
in class BaseSourceAdapter
SubjectNotFoundException
SubjectNotUniqueException
BaseSourceAdapter.getSubject(java.lang.String)
@Deprecated public Subject getSubjectByIdentifier(String id1) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdentifier
in interface Source
getSubjectByIdentifier
in class BaseSourceAdapter
SubjectNotFoundException
SubjectNotUniqueException
BaseSourceAdapter.getSubjectByIdentifier(java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |