|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.subject.LazySource
public class LazySource
if the id or sources might not be known, dont resolve until you need it
Constructor Summary | |
---|---|
LazySource()
default constructor |
|
LazySource(String theSourceId)
construct with source id |
Method Summary | |
---|---|
void |
checkConfig()
make sure the config is ok, and log descriptive errors if not |
String |
getId()
Returns the ID of this source. |
String |
getInitParam(String name1)
get the init param e.g. |
Properties |
getInitParams()
get the init params e.g. |
String |
getName()
Returns the name of this source. |
Subject |
getSubject(String id)
Gets a Subject by its ID. |
Subject |
getSubject(String id,
boolean exceptionIfNull)
Gets a Subject by its ID. |
Subject |
getSubjectByIdentifier(String id)
Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID. |
Subject |
getSubjectByIdentifier(String id,
boolean exceptionIfNull)
Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID. |
Subject |
getSubjectByIdOrIdentifier(String idOrIdentifier,
boolean exceptionIfNull)
find by id or identifier. |
Map<String,Subject> |
getSubjectsByIdentifiers(Collection<String> identifiers)
Get subjects by identifiers. |
Map<String,Subject> |
getSubjectsByIds(Collection<String> ids)
Get subjects by ids. |
Map<String,Subject> |
getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Get subjects by ids or identifiers. |
Set<SubjectType> |
getSubjectTypes()
Gets the SubjectTypes supported by this source. |
String |
getUnderlyingSourceId()
id of underlying 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. |
void |
setId(String id)
Sets the ID of this source. |
void |
setName(String name)
Sets the name of this source. |
void |
setUnderlyingSourceId(String sourceId1)
id of underlying source |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LazySource()
public LazySource(String theSourceId)
theSourceId
- Method Detail |
---|
public String getUnderlyingSourceId()
public void setUnderlyingSourceId(String sourceId1)
sourceId1
- the sourceId to setpublic void checkConfig()
Source
checkConfig
in interface Source
Source.checkConfig()
public String getId()
Source
getId
in interface Source
Source.getId()
public String getName()
Source
getName
in interface Source
Source.getName()
public Subject getSubject(String id) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubject
in interface Source
id
-
SubjectNotFoundException
SubjectNotUniqueException
public Subject getSubject(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubject
in interface Source
exceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returned
SubjectNotFoundException
SubjectNotUniqueException
Source.getSubject(java.lang.String, boolean)
public Subject getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdOrIdentifier
in interface Source
exceptionIfNull
- if SubjectNotFoundException or null
SubjectNotFoundException
SubjectNotUniqueException
Source.getSubjectByIdOrIdentifier(java.lang.String, boolean)
public Subject getSubjectByIdentifier(String id) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdentifier
in interface Source
id
-
SubjectNotFoundException
SubjectNotUniqueException
public Subject getSubjectByIdentifier(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdentifier
in interface Source
SubjectNotFoundException
SubjectNotUniqueException
Source.getSubjectByIdentifier(java.lang.String, boolean)
public Set<SubjectType> getSubjectTypes()
Source
getSubjectTypes
in interface Source
Source.getSubjectTypes()
public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)
Source
getSubjectsByIdentifiers
in interface Source
Source.getSubjectsByIdentifiers(java.util.Collection)
public Map<String,Subject> getSubjectsByIds(Collection<String> ids)
Source
getSubjectsByIds
in interface Source
Source.getSubjectsByIds(java.util.Collection)
public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Source
getSubjectsByIdsOrIdentifiers
in interface Source
idsOrIdentifiers
- each string could be a subject id or identifier
Source.getSubjectsByIdsOrIdentifiers(java.util.Collection)
public void init() throws SourceUnavailableException
Source
init
in interface Source
SourceUnavailableException
Source.init()
public String printConfig()
Source
printConfig
in interface Source
Source.printConfig()
public Set<Subject> search(String searchValue)
Source
search
in interface Source
Source.search(java.lang.String)
public void setId(String id)
Source
setId
in interface Source
Source.setId(java.lang.String)
public void setName(String name)
Source
setName
in interface Source
Source.setName(java.lang.String)
public String getInitParam(String name1)
Source
getInitParam
in interface Source
Source.getInitParam(java.lang.String)
public Properties getInitParams()
Source
getInitParams
in interface Source
Source.getInitParams()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |