|
||||||||||
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 | |
---|---|
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.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)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(java.lang.String idOrIdentifier)
|
edu.internet2.middleware.subject.Subject |
findByIdOrIdentifier(java.lang.String id,
java.lang.String source)
|
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 SubjectResolver
id
- 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 SubjectResolver
id
- 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 SubjectResolver
query
- 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 SubjectResolver
query
- 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 SubjectResolver
id
- 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 SubjectResolver
id
- 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 SubjectResolver
java.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 SubjectResolver
SubjectResolver.getSources()
public java.util.Set<edu.internet2.middleware.subject.Source> getSources(java.lang.String subjectType) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
SubjectResolver#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 SubjectResolver
idOrIdentifier
- 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 SubjectResolver
id
- 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 SubjectResolver
stemName
- 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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |