Package edu.internet2.middleware.grouper.subj

Class SourcesXmlResolver

java.lang.Object

edu.internet2.middleware.grouper.subj.SourcesXmlResolver

All Implemented Interfaces:

SubjectResolver

public class SourcesXmlResolver
extends Object
implements SubjectResolver

Wrapper around Subject sources configured in subject.properties.

Since:

1.2.1

Version:

$Id: SourcesXmlResolver.java,v 1.13 2009-10-19 19:01:55 mchyzer Exp $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SourcesXmlResolver.LogLabelCallable<T>	TODO merge this with GrouperCallable

Constructor Summary

Constructors

Constructor	Description
SourcesXmlResolver()	Initialize a new SourcesXmlResolver.

Method Summary

Modifier and Type	Method	Description
Subject	find(String id)
Subject	find(String id, boolean ignoreCachedSubjects)
Subject	find(String id, String source)
Subject	find(String id, String source, boolean ignoreCachedSubjects)
Set<Subject>	findAll(String query)
Set<Subject>	findAll(String query, String source)
Set<Subject>	findAll(String query, Set<Source> sources)	find subjects in a set of sources
Set<Subject>	findAllInStem(String stemName, String query)	note if stem name is blank, it means root
Subject	findByIdentifier(String id)
Subject	findByIdentifier(String id, boolean ignoreCachedSubjects)
Subject	findByIdentifier(String id, String source)
Subject	findByIdentifier(String id, String source, boolean ignoreCachedSubjects)
Map<String,Subject>	findByIdentifiers(Collection<String> identifiers)
Map<String,Subject>	findByIdentifiers(Collection<String> identifiers, String source)
Subject	findByIdOrIdentifier(String idOrIdentifier)
Subject	findByIdOrIdentifier(String idOrIdentifier, boolean ignoreCachedSubjects)
Subject	findByIdOrIdentifier(String id, String source)
Subject	findByIdOrIdentifier(String id, String source, boolean ignoreCachedSubjects)
Map<String,Subject>	findByIds(Collection<String> ids)
Map<String,Subject>	findByIds(Collection<String> ids, String source)
Map<String,Subject>	findByIds(Collection<String> ids, String source, boolean ignoreCachedSubjects)
Map<String,Subject>	findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Map<String,Subject>	findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, String source)
Map<String,Subject>	findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, Set<Source> sources)
SearchPageResult	findPage(String query)
SearchPageResult	findPage(String query, String source)
SearchPageResult	findPage(String query, Set<Source> sources)	find a page of subjects in a set of sources
SearchPageResult	findPageInStem(String stemName, String query)	note if stem name is blank, it means root
SearchPageResult	findPageInStem(String stemName, String query, Set<Source> sources)	note if stem name is blank, it means root
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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SourcesXmlResolver

public SourcesXmlResolver()

Initialize a new SourcesXmlResolver.

Since:

1.2.1

Method Details

flushCache

public void flushCache()

flush the cache (e.g. for testing)

Specified by:

flushCache in interface SubjectResolver

find

public Subject find(String id)
             throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

find in interface SubjectResolver

Parameters:

id - Subject id to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

See Also:

• SubjectResolver.find(String)

find

public Subject find(String id,
 boolean ignoreCachedSubjects)
             throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

find in interface SubjectResolver

Parameters:

id - Subject id to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

See Also:

• SubjectResolver.find(String, boolean)

find

public Subject find(String id,
 String source)
             throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

find in interface SubjectResolver

Parameters:

id - Subject id to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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.

Since:

1.2.1

See Also:

• SubjectResolver#find(String, String, String)

find

public Subject find(String id,
 String source,
 boolean ignoreCachedSubjects)
             throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

find in interface SubjectResolver

Parameters:

id -

source -

ignoreCachedSubjects -

Returns:

Subject matching search parameters.

Throws:

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.

findAll

public Set<Subject> findAll(String query)
                     throws IllegalArgumentException

Specified by:

findAll in interface SubjectResolver

Parameters:

query - A source-appropraite query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

1.2.1

See Also:

• SubjectResolver.findAll(String)

findAll

public Set<Subject> findAll(String query,
 String source)
                     throws IllegalArgumentException,
SourceUnavailableException

Specified by:

findAll in interface SubjectResolver

Parameters:

query - A source-appropriate query string.

source - Restrict query to within this source.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

Since:

1.2.1

See Also:

• SubjectResolver.findAll(String, String)

findByIdentifier

public Subject findByIdentifier(String id)
                         throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdentifier in interface SubjectResolver

Parameters:

id - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

Since:

1.2.1

See Also:

• SubjectResolver.findByIdentifier(String)

findByIdentifier

public Subject findByIdentifier(String id,
 boolean ignoreCachedSubjects)
                         throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdentifier in interface SubjectResolver

Parameters:

id - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

See Also:

• SubjectResolver.findByIdentifier(String, boolean)

findByIdentifier

public Subject findByIdentifier(String id,
 String source)
                         throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdentifier in interface SubjectResolver

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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.

Since:

1.2.1

See Also:

• SubjectResolver#findByIdentifier(String, String, String)

findByIdentifier

public Subject findByIdentifier(String id,
 String source,
 boolean ignoreCachedSubjects)
                         throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdentifier in interface SubjectResolver

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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.

See Also:

• SubjectResolver#findByIdentifier(String, String, String, boolean)

getSource

public Source getSource(String id)
                 throws IllegalArgumentException,
SourceUnavailableException

Specified by:

getSource in interface SubjectResolver

Returns:

Subject source identified by id.

Throws:

IllegalArgumentException - if id is null.

SourceUnavailableException - if source cannot be returned.

Since:

1.2.1

See Also:

• SubjectResolver.getSource(String)

getSources

public Set<Source> getSources()

Specified by:

getSources in interface SubjectResolver

Returns:

All Subject sources.

Since:

1.2.1

See Also:

• SubjectResolver.getSources()

getSources

public Set<Source> getSources(String subjectType)
                       throws IllegalArgumentException

Parameters:

subjectType -

Returns:

the sources

Throws:

IllegalArgumentException

Since:

1.2.1

See Also:

• SubjectResolver#getSources(String)

findByIdOrIdentifier

public Subject findByIdOrIdentifier(String idOrIdentifier)
                             throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdOrIdentifier in interface SubjectResolver

Parameters:

idOrIdentifier - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

See Also:

• SubjectResolver.findByIdOrIdentifier(String)

findByIdOrIdentifier

public Subject findByIdOrIdentifier(String idOrIdentifier,
 boolean ignoreCachedSubjects)
                             throws IllegalArgumentException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdOrIdentifier in interface SubjectResolver

Parameters:

idOrIdentifier - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

IllegalArgumentException - if any parameter is null.

SubjectNotFoundException - if no matching subject is found.

SubjectNotUniqueException - if more than one matching subject is found.

See Also:

• SubjectResolver.findByIdOrIdentifier(String, boolean)

findByIdOrIdentifier

public Subject findByIdOrIdentifier(String id,
 String source)
                             throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdOrIdentifier in interface SubjectResolver

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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.

See Also:

• SubjectResolver.findByIdOrIdentifier(String, String)

findByIdOrIdentifier

public Subject findByIdOrIdentifier(String id,
 String source,
 boolean ignoreCachedSubjects)
                             throws IllegalArgumentException,
SourceUnavailableException,
SubjectNotFoundException,
SubjectNotUniqueException

Specified by:

findByIdOrIdentifier in interface SubjectResolver

Parameters:

id - Subject identifier to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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.

See Also:

• SubjectResolver.findByIdOrIdentifier(String, String, boolean)

findAllInStem

public Set<Subject> findAllInStem(String stemName,
 String query)
                           throws IllegalArgumentException

note if stem name is blank, it means root

Specified by:

findAllInStem in interface SubjectResolver

Parameters:

stemName - name of stem we are querying

query - A source-appropriate query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• SubjectResolver.findAllInStem(java.lang.String, java.lang.String)

findPage

public SearchPageResult findPage(String query)
                          throws IllegalArgumentException

Specified by:

findPage in interface SubjectResolver

Parameters:

query - A source-appropraite query string.

Returns:

Paged subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

Since:

1.2.1

See Also:

• SubjectResolver.findPage(String)

findPage

public SearchPageResult findPage(String query,
 String source)
                          throws IllegalArgumentException,
SourceUnavailableException

Specified by:

findPage in interface SubjectResolver

Parameters:

query - A source-appropriate query string.

source - Restrict query to within this source.

Returns:

Page of subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

Since:

1.2.1

See Also:

• SubjectResolver.findAll(String, String)

findPageInStem

public SearchPageResult findPageInStem(String stemName,
 String query)
                                throws IllegalArgumentException

note if stem name is blank, it means root

Specified by:

findPageInStem in interface SubjectResolver

Parameters:

stemName - name of stem we are querying

query - A source-appropriate query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• SubjectResolver.findAllInStem(java.lang.String, java.lang.String)

findPageInStem

public SearchPageResult findPageInStem(String stemName,
 String query,
 Set<Source> sources)
                                throws IllegalArgumentException

note if stem name is blank, it means root

Specified by:

findPageInStem in interface SubjectResolver

Parameters:

stemName - name of stem we are querying

query - A source-appropriate query string.

Returns:

All subjects matching query.

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• edu.internet2.middleware.grouper.subj.SubjectResolver#findAllInStem(java.lang.String, java.lang.String, Set)

findAll

public Set<Subject> findAll(String query,
 Set<Source> sources)

Description copied from interface: SubjectResolver

find subjects in a set of sources

Specified by:

findAll in interface SubjectResolver

Returns:

the subjects

See Also:

• SubjectResolver.findAll(String, Set)

findPage

public SearchPageResult findPage(String query,
 Set<Source> sources)
                          throws SourceUnavailableException

Description copied from interface: SubjectResolver

find a page of subjects in a set of sources

Specified by:

findPage in interface SubjectResolver

Returns:

the page of subjects

Throws:

SourceUnavailableException

See Also:

• SubjectResolver.findPage(String, Set)

findByIdentifiers

public Map<String,Subject> findByIdentifiers(Collection<String> identifiers)
                                      throws IllegalArgumentException

Specified by:

findByIdentifiers in interface SubjectResolver

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• SubjectResolver.findByIdentifiers(Collection)

findByIdentifiers

public Map<String,Subject> findByIdentifiers(Collection<String> identifiers,
 String source)
                                      throws IllegalArgumentException,
SourceUnavailableException

Specified by:

findByIdentifiers in interface SubjectResolver

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

See Also:

• SubjectResolver.findByIdentifiers(Collection, String)

findByIds

public Map<String,Subject> findByIds(Collection<String> ids)
                              throws IllegalArgumentException

Specified by:

findByIds in interface SubjectResolver

Parameters:

ids - Subject id to search on.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• SubjectResolver.findByIds(Collection)

findByIds

public Map<String,Subject> findByIds(Collection<String> ids,
 String source,
 boolean ignoreCachedSubjects)
                              throws IllegalArgumentException,
SourceUnavailableException

Specified by:

findByIds in interface SubjectResolver

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

See Also:

• SubjectResolver.findByIds(Collection, String, boolean)

findByIds

public Map<String,Subject> findByIds(Collection<String> ids,
 String source)
                              throws IllegalArgumentException,
SourceUnavailableException

Specified by:

findByIds in interface SubjectResolver

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

See Also:

• SubjectResolver.findByIds(Collection, String)

findByIdsOrIdentifiers

public Map<String,Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
                                           throws IllegalArgumentException

Specified by:

findByIdsOrIdentifiers in interface SubjectResolver

Parameters:

idsOrIdentifiers - Subject identifiers to search on.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• SubjectResolver.findByIdsOrIdentifiers(Collection)

findByIdsOrIdentifiers

public Map<String,Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
 Set<Source> sources)
                                           throws IllegalArgumentException

Specified by:

findByIdsOrIdentifiers in interface SubjectResolver

sources - Source adapters to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

See Also:

• SubjectResolver.findByIdsOrIdentifiers(Collection)

findByIdsOrIdentifiers

public Map<String,Subject> findByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
 String source)
                                           throws IllegalArgumentException,
SourceUnavailableException

Specified by:

findByIdsOrIdentifiers in interface SubjectResolver

source - Source adapter to search within.

Returns:

map of search param to subject

Throws:

IllegalArgumentException - if any parameter is null.

SourceUnavailableException - if source is unavailable.

See Also:

• SubjectResolver.findByIdsOrIdentifiers(Collection, String)