|
||||||||||
| 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.
| Nested Class Summary | |
|---|---|
static class |
SourcesXmlResolver.LogLabelCallable<T>
|
| Constructor Summary | |
|---|---|
SourcesXmlResolver()
Initialize a new SourcesXmlResolver. |
|
| Method Summary | |
|---|---|
edu.internet2.middleware.subject.Subject |
find(java.lang.String id)
|
edu.internet2.middleware.subject.Subject |
find(java.lang.String id,
java.lang.String source)
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAll(java.lang.String query)
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAll(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
find subjects in a set of sources |
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAll(java.lang.String query,
java.lang.String source)
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
findAllInStem(java.lang.String stemName,
java.lang.String query)
note if stem name is blank, it means root |
edu.internet2.middleware.subject.Subject |
findByIdentifier(java.lang.String id)
|
edu.internet2.middleware.subject.Subject |
findByIdentifier(java.lang.String id,
java.lang.String source)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdentifiers(java.util.Collection<java.lang.String> identifiers)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdentifiers(java.util.Collection<java.lang.String> identifiers,
java.lang.String source)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(java.lang.String idOrIdentifier)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(java.lang.String id,
java.lang.String source)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIds(java.util.Collection<java.lang.String> ids)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIds(java.util.Collection<java.lang.String> ids,
java.lang.String source)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers,
java.lang.String source)
|
edu.internet2.middleware.subject.SearchPageResult |
findPage(java.lang.String query)
|
edu.internet2.middleware.subject.SearchPageResult |
findPage(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
find a page of subjects in a set of sources |
edu.internet2.middleware.subject.SearchPageResult |
findPage(java.lang.String query,
java.lang.String source)
|
edu.internet2.middleware.subject.SearchPageResult |
findPageInStem(java.lang.String stemName,
java.lang.String query)
note if stem name is blank, it means root |
void |
flushCache()
flush the cache (e.g. for testing) |
edu.internet2.middleware.subject.Source |
getSource(java.lang.String id)
|
java.util.Set<edu.internet2.middleware.subject.Source> |
getSources()
|
java.util.Set<edu.internet2.middleware.subject.Source> |
getSources(java.lang.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(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
find in interface SubjectResolverid - Subject id to search on.
java.lang.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(java.lang.String id,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
find in interface SubjectResolverid - Subject id to search on.source - Source adapter to search within.
java.lang.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 java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query)
throws java.lang.IllegalArgumentException
findAll in interface SubjectResolverquery - A source-appropraite query string.
java.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findAll(String)
public java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
findAll in interface SubjectResolverquery - A source-appropriate query string.source - Restrict query to within this source.
java.lang.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(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdentifier in interface SubjectResolverid - Subject identifier to search on.
java.lang.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(java.lang.String id,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdentifier in interface SubjectResolverid - Subject identifier to search on.source - Source adapter to search within.
java.lang.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(java.lang.String id)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
getSource in interface SubjectResolverjava.lang.IllegalArgumentException - if id is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source cannot be returned.SubjectResolver.getSource(String)public java.util.Set<edu.internet2.middleware.subject.Source> getSources()
getSources in interface SubjectResolverSubjectResolver.getSources()
public java.util.Set<edu.internet2.middleware.subject.Source> getSources(java.lang.String subjectType)
throws java.lang.IllegalArgumentException
subjectType -
java.lang.IllegalArgumentExceptionSubjectResolver#getSources(String)
public edu.internet2.middleware.subject.Subject findByIdOrIdentifier(java.lang.String idOrIdentifier)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdOrIdentifier in interface SubjectResolveridOrIdentifier - Subject identifier to search on.
java.lang.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(java.lang.String id,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException,
edu.internet2.middleware.subject.SubjectNotFoundException,
edu.internet2.middleware.subject.SubjectNotUniqueException
findByIdOrIdentifier in interface SubjectResolverid - Subject identifier to search on.source - Source adapter to search within.
java.lang.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 java.util.Set<edu.internet2.middleware.subject.Subject> findAllInStem(java.lang.String stemName,
java.lang.String query)
throws java.lang.IllegalArgumentException
findAllInStem in interface SubjectResolverstemName - name of stem we are queryingquery - A source-appropriate query string.
java.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findAllInStem(java.lang.String, java.lang.String)
public edu.internet2.middleware.subject.SearchPageResult findPage(java.lang.String query)
throws java.lang.IllegalArgumentException
findPage in interface SubjectResolverquery - A source-appropraite query string.
java.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findAll(String)
public edu.internet2.middleware.subject.SearchPageResult findPage(java.lang.String query,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
findPage in interface SubjectResolverquery - A source-appropriate query string.source - Restrict query to within this source.
java.lang.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(java.lang.String stemName,
java.lang.String query)
throws java.lang.IllegalArgumentException
findPageInStem in interface SubjectResolverstemName - name of stem we are queryingquery - A source-appropriate query string.
java.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findAllInStem(java.lang.String, java.lang.String)
public java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
SubjectResolver
findAll in interface SubjectResolverSubjectResolver.findAll(String, Set)
public edu.internet2.middleware.subject.SearchPageResult findPage(java.lang.String query,
java.util.Set<edu.internet2.middleware.subject.Source> sources)
throws edu.internet2.middleware.subject.SourceUnavailableException
SubjectResolver
findPage in interface SubjectResolveredu.internet2.middleware.subject.SourceUnavailableExceptionSubjectResolver.findPage(String, Set)
public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdentifiers(java.util.Collection<java.lang.String> identifiers)
throws java.lang.IllegalArgumentException
findByIdentifiers in interface SubjectResolverjava.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findByIdentifiers(Collection)
public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdentifiers(java.util.Collection<java.lang.String> identifiers,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
findByIdentifiers in interface SubjectResolversource - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.SubjectResolver.findByIdentifiers(Collection, String)
public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIds(java.util.Collection<java.lang.String> ids)
throws java.lang.IllegalArgumentException
findByIds in interface SubjectResolverids - Subject id to search on.
java.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findByIds(Collection)
public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIds(java.util.Collection<java.lang.String> ids,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
findByIds in interface SubjectResolversource - Source adapter to search within.
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.SubjectResolver.findByIds(Collection, String)
public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers)
throws java.lang.IllegalArgumentException
findByIdsOrIdentifiers in interface SubjectResolveridsOrIdentifiers - Subject identifiers to search on.
java.lang.IllegalArgumentException - if any parameter is null.SubjectResolver.findByIdsOrIdentifiers(Collection)
public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> findByIdsOrIdentifiers(java.util.Collection<java.lang.String> idsOrIdentifiers,
java.lang.String source)
throws java.lang.IllegalArgumentException,
edu.internet2.middleware.subject.SourceUnavailableException
findByIdsOrIdentifiers in interface SubjectResolversource - Source adapter to search within.
java.lang.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 | |||||||||