|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.subj.SourcesXmlResolver
public class SourcesXmlResolver
Wrapper around Subject sources configured in sources.xml
.
Constructor Summary | |
---|---|
SourcesXmlResolver()
Initialize a new SourcesXmlResolver. |
Method Summary | |
---|---|
Subject |
find(String id)
|
Subject |
find(String id,
String source)
|
Set<Subject> |
findAll(String query)
|
Set<Subject> |
findAll(String query,
String source)
|
Set<Subject> |
findAllInStem(String stemName,
String query)
note if stem name is blank, it means root |
Subject |
findByIdentifier(String id)
|
Subject |
findByIdentifier(String id,
String source)
|
Subject |
findByIdOrIdentifier(String idOrIdentifier)
|
Subject |
findByIdOrIdentifier(String id,
String source)
|
void |
flushCache()
flush the cache (e.g. |
Source |
getSource(String id)
|
Set<Source> |
getSources()
|
Set<Source> |
getSources(String subjectType)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SourcesXmlResolver()
Method Detail |
---|
public void flushCache()
flushCache
in interface SubjectResolver
public Subject find(String id) throws IllegalArgumentException, SubjectNotFoundException, SubjectNotUniqueException
find
in interface SubjectResolver
id
- Subject id to search on.
IllegalArgumentException
- if any parameter is null.
SubjectNotFoundException
- if no matching subject is found.
SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.find(String)
public Subject find(String id, String source) throws IllegalArgumentException, SourceUnavailableException, SubjectNotFoundException, SubjectNotUniqueException
find
in interface SubjectResolver
id
- Subject id to search on.source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
SourceUnavailableException
- if source is unavailable.
SubjectNotFoundException
- if no matching subject is found.
SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver#find(String, String, String)
public Set<Subject> findAll(String query) throws IllegalArgumentException
findAll
in interface SubjectResolver
query
- A source-appropraite query string.
IllegalArgumentException
- if any parameter is null.SubjectResolver.findAll(String)
public Set<Subject> findAll(String query, String source) throws IllegalArgumentException, SourceUnavailableException
findAll
in interface SubjectResolver
query
- A source-appropriate query string.source
- Restrict query to within this source.
IllegalArgumentException
- if any parameter is null.
SourceUnavailableException
- if source is unavailable.SubjectResolver.findAll(String, String)
public Subject findByIdentifier(String id) throws IllegalArgumentException, SubjectNotFoundException, SubjectNotUniqueException
findByIdentifier
in interface SubjectResolver
id
- Subject identifier to search on.
IllegalArgumentException
- if any parameter is null.
SubjectNotFoundException
- if no matching subject is found.
SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.findByIdentifier(String)
public Subject findByIdentifier(String id, String source) throws IllegalArgumentException, SourceUnavailableException, SubjectNotFoundException, SubjectNotUniqueException
findByIdentifier
in interface SubjectResolver
id
- Subject identifier to search on.source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
SourceUnavailableException
- if source is unavailable.
SubjectNotFoundException
- if no matching subject is found.
SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver#findByIdentifier(String, String, String)
public Source getSource(String id) throws IllegalArgumentException, SourceUnavailableException
getSource
in interface SubjectResolver
IllegalArgumentException
- if id is null.
SourceUnavailableException
- if source cannot be returned.SubjectResolver.getSource(String)
public Set<Source> getSources()
getSources
in interface SubjectResolver
SubjectResolver.getSources()
public Set<Source> getSources(String subjectType) throws IllegalArgumentException
IllegalArgumentException
SubjectResolver#getSources(String)
public Subject findByIdOrIdentifier(String idOrIdentifier) throws IllegalArgumentException, SubjectNotFoundException, SubjectNotUniqueException
findByIdOrIdentifier
in interface SubjectResolver
idOrIdentifier
- Subject identifier to search on.
IllegalArgumentException
- if any parameter is null.
SubjectNotFoundException
- if no matching subject is found.
SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.findByIdOrIdentifier(String)
public Subject findByIdOrIdentifier(String id, String source) throws IllegalArgumentException, SourceUnavailableException, SubjectNotFoundException, SubjectNotUniqueException
findByIdOrIdentifier
in interface SubjectResolver
id
- Subject identifier to search on.source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
SourceUnavailableException
- if source is unavailable.
SubjectNotFoundException
- if no matching subject is found.
SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.findByIdOrIdentifier(String, String)
public Set<Subject> findAllInStem(String stemName, String query) throws IllegalArgumentException
findAllInStem
in interface SubjectResolver
stemName
- name of stem we are queryingquery
- A source-appropriate query string.
IllegalArgumentException
- if any parameter is null.SubjectResolver.findAllInStem(java.lang.String, java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |