|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object edu.internet2.middleware.grouper.subj.SourcesXmlResolver
public class SourcesXmlResolver
Wrapper around Subject sources configured in sources.xml
.
Nested Class Summary | |
---|---|
static class |
SourcesXmlResolver.LogLabelCallable<T>
TODO merge this with GrouperCallable |
Constructor Summary | |
---|---|
SourcesXmlResolver()
Initialize a new SourcesXmlResolver. |
Method Summary | |
---|---|
edu.internet2.middleware.subject.Subject |
find(String id)
|
edu.internet2.middleware.subject.Subject |
find(String id,
String source)
|
Set<edu.internet2.middleware.subject.Subject> |
findAll(String query)
|
Set<edu.internet2.middleware.subject.Subject> |
findAll(String query,
Set<edu.internet2.middleware.subject.Source> sources)
find subjects in a set of sources |
Set<edu.internet2.middleware.subject.Subject> |
findAll(String query,
String source)
|
Set<edu.internet2.middleware.subject.Subject> |
findAllInStem(String stemName,
String query)
note if stem name is blank, it means root |
edu.internet2.middleware.subject.Subject |
findByIdentifier(String id)
|
edu.internet2.middleware.subject.Subject |
findByIdentifier(String id,
String source)
|
Map<String,edu.internet2.middleware.subject.Subject> |
findByIdentifiers(Collection<String> identifiers)
|
Map<String,edu.internet2.middleware.subject.Subject> |
findByIdentifiers(Collection<String> identifiers,
String source)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(String idOrIdentifier)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(String id,
String source)
|
Map<String,edu.internet2.middleware.subject.Subject> |
findByIds(Collection<String> ids)
|
Map<String,edu.internet2.middleware.subject.Subject> |
findByIds(Collection<String> ids,
String source)
|
Map<String,edu.internet2.middleware.subject.Subject> |
findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
|
Map<String,edu.internet2.middleware.subject.Subject> |
findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
String source)
|
edu.internet2.middleware.subject.SearchPageResult |
findPage(String query)
|
edu.internet2.middleware.subject.SearchPageResult |
findPage(String query,
Set<edu.internet2.middleware.subject.Source> sources)
find a page of subjects in a set of sources |
edu.internet2.middleware.subject.SearchPageResult |
findPage(String query,
String source)
|
edu.internet2.middleware.subject.SearchPageResult |
findPageInStem(String stemName,
String query)
note if stem name is blank, it means root |
edu.internet2.middleware.subject.SearchPageResult |
findPageInStem(String stemName,
String query,
Set<edu.internet2.middleware.subject.Source> sources)
note if stem name is blank, it means root |
void |
flushCache()
flush the cache (e.g. |
edu.internet2.middleware.subject.Source |
getSource(String id)
|
Set<edu.internet2.middleware.subject.Source> |
getSources()
|
Set<edu.internet2.middleware.subject.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 edu.internet2.middleware.subject.Subject find(String id) throws IllegalArgumentException, edu.internet2.middleware.subject.SubjectNotFoundException, edu.internet2.middleware.subject.SubjectNotUniqueException
find
in interface SubjectResolver
id
- Subject id to search on.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException
- if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.find(String)
public edu.internet2.middleware.subject.Subject find(String id, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException, edu.internet2.middleware.subject.SubjectNotFoundException, edu.internet2.middleware.subject.SubjectNotUniqueException
find
in interface SubjectResolver
id
- Subject id to search on.source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException
- if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver#find(String, String, String)
public Set<edu.internet2.middleware.subject.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<edu.internet2.middleware.subject.Subject> findAll(String query, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException
findAll
in interface SubjectResolver
query
- A source-appropriate query string.source
- Restrict query to within this source.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.SubjectResolver.findAll(String, String)
public edu.internet2.middleware.subject.Subject findByIdentifier(String id) throws IllegalArgumentException, edu.internet2.middleware.subject.SubjectNotFoundException, edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdentifier
in interface SubjectResolver
id
- Subject identifier to search on.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException
- if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.findByIdentifier(String)
public edu.internet2.middleware.subject.Subject findByIdentifier(String id, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException, edu.internet2.middleware.subject.SubjectNotFoundException, edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdentifier
in interface SubjectResolver
id
- Subject identifier to search on.source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException
- if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver#findByIdentifier(String, String, String)
public edu.internet2.middleware.subject.Source getSource(String id) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException
getSource
in interface SubjectResolver
IllegalArgumentException
- if id is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source cannot be returned.SubjectResolver.getSource(String)
public Set<edu.internet2.middleware.subject.Source> getSources()
getSources
in interface SubjectResolver
SubjectResolver.getSources()
public Set<edu.internet2.middleware.subject.Source> getSources(String subjectType) throws IllegalArgumentException
subjectType
-
IllegalArgumentException
SubjectResolver#getSources(String)
public edu.internet2.middleware.subject.Subject findByIdOrIdentifier(String idOrIdentifier) throws IllegalArgumentException, edu.internet2.middleware.subject.SubjectNotFoundException, edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdOrIdentifier
in interface SubjectResolver
idOrIdentifier
- Subject identifier to search on.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SubjectNotFoundException
- if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.findByIdOrIdentifier(String)
public edu.internet2.middleware.subject.Subject findByIdOrIdentifier(String id, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException, edu.internet2.middleware.subject.SubjectNotFoundException, edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdOrIdentifier
in interface SubjectResolver
id
- Subject identifier to search on.source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.
edu.internet2.middleware.subject.SubjectNotFoundException
- if no matching subject is found.
edu.internet2.middleware.subject.SubjectNotUniqueException
- if more than one matching subject is found.SubjectResolver.findByIdOrIdentifier(String, String)
public Set<edu.internet2.middleware.subject.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)
public edu.internet2.middleware.subject.SearchPageResult findPage(String query) throws IllegalArgumentException
findPage
in interface SubjectResolver
query
- A source-appropraite query string.
IllegalArgumentException
- if any parameter is null.SubjectResolver.findPage(String)
public edu.internet2.middleware.subject.SearchPageResult findPage(String query, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException
findPage
in interface SubjectResolver
query
- A source-appropriate query string.source
- Restrict query to within this source.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.SubjectResolver.findAll(String, String)
public edu.internet2.middleware.subject.SearchPageResult findPageInStem(String stemName, String query) throws IllegalArgumentException
findPageInStem
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)
public edu.internet2.middleware.subject.SearchPageResult findPageInStem(String stemName, String query, Set<edu.internet2.middleware.subject.Source> sources) throws IllegalArgumentException
findPageInStem
in interface SubjectResolver
stemName
- name of stem we are queryingquery
- A source-appropriate query string.
IllegalArgumentException
- if any parameter is null.edu.internet2.middleware.grouper.subj.SubjectResolver#findAllInStem(java.lang.String, java.lang.String, Set)
public Set<edu.internet2.middleware.subject.Subject> findAll(String query, Set<edu.internet2.middleware.subject.Source> sources)
SubjectResolver
findAll
in interface SubjectResolver
SubjectResolver.findAll(String, Set)
public edu.internet2.middleware.subject.SearchPageResult findPage(String query, Set<edu.internet2.middleware.subject.Source> sources) throws edu.internet2.middleware.subject.SourceUnavailableException
SubjectResolver
findPage
in interface SubjectResolver
edu.internet2.middleware.subject.SourceUnavailableException
SubjectResolver.findPage(String, Set)
public Map<String,edu.internet2.middleware.subject.Subject> findByIdentifiers(Collection<String> identifiers) throws IllegalArgumentException
findByIdentifiers
in interface SubjectResolver
IllegalArgumentException
- if any parameter is null.SubjectResolver.findByIdentifiers(Collection)
public Map<String,edu.internet2.middleware.subject.Subject> findByIdentifiers(Collection<String> identifiers, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException
findByIdentifiers
in interface SubjectResolver
source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.SubjectResolver.findByIdentifiers(Collection, String)
public Map<String,edu.internet2.middleware.subject.Subject> findByIds(Collection<String> ids) throws IllegalArgumentException
findByIds
in interface SubjectResolver
ids
- Subject id to search on.
IllegalArgumentException
- if any parameter is null.SubjectResolver.findByIds(Collection)
public Map<String,edu.internet2.middleware.subject.Subject> findByIds(Collection<String> ids, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException
findByIds
in interface SubjectResolver
source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.SubjectResolver.findByIds(Collection, String)
public Map<String,edu.internet2.middleware.subject.Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers) throws IllegalArgumentException
findByIdsOrIdentifiers
in interface SubjectResolver
idsOrIdentifiers
- Subject identifiers to search on.
IllegalArgumentException
- if any parameter is null.SubjectResolver.findByIdsOrIdentifiers(Collection)
public Map<String,edu.internet2.middleware.subject.Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, String source) throws IllegalArgumentException, edu.internet2.middleware.subject.SourceUnavailableException
findByIdsOrIdentifiers
in interface SubjectResolver
source
- Source adapter to search within.
IllegalArgumentException
- if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException
- if source is unavailable.SubjectResolver.findByIdsOrIdentifiers(Collection, String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |