Package edu.internet2.middleware.grouper.subj

Class CachingResolver

java.lang.Object

edu.internet2.middleware.grouper.subj.SubjectResolverDecorator

edu.internet2.middleware.grouper.subj.CachingResolver

All Implemented Interfaces:

SubjectResolver

public class CachingResolver
extends SubjectResolverDecorator

Decorator that provides caching for SubjectResolver. TODO the caching of findAll should work based on group restricted to, not stem name

Since:

1.2.1

Version:

$Id: CachingResolver.java,v 1.8 2008-08-26 21:11:51 mchyzer Exp $

Constructor Summary

Constructors

Constructor	Description
CachingResolver(SubjectResolver resolver)

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)
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 id)
Subject	findByIdOrIdentifier(String id, 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)
SearchPageResult	findPageInStem(String stemName, String query, Set<Source> sources)
void	flushCache()	flush the cache (e.g.
Source	getSource(String id)
Set<Source>	getSources()

Methods inherited from class edu.internet2.middleware.grouper.subj.SubjectResolverDecorator

getDecoratedResolver

Methods inherited from class java.lang.Object

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

Constructor Details

CachingResolver

public CachingResolver(SubjectResolver resolver)

Since:

1.2.1

Method Details

flushCache

public void flushCache()

flush the cache (e.g. for testing)

find

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

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

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

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)

find

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

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, boolean)

findAll

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

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

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

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

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

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)

findByIdentifier

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

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, boolean)

getSource

public Source getSource(String id)
                 throws IllegalArgumentException,
SourceUnavailableException

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()

Returns:

All Subject sources.

Since:

1.2.1

See Also:

• SubjectResolver.getSources()

findByIdOrIdentifier

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

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.

findByIdOrIdentifier

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

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.

findByIdOrIdentifier

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

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

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

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

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)

findAll

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

Description copied from interface: SubjectResolver

find subjects in a set of sources

Returns:

the subjects

Throws:

IllegalArgumentException

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

Returns:

the page of subjects

Throws:

SourceUnavailableException

See Also:

• SubjectResolver.findPage(String)

findPage

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

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:

2.0.2

See Also:

• SubjectResolver.findPage(String, String)

findPageInStem

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

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

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.findPageInStem(java.lang.String, java.lang.String, Set)

findByIdentifiers

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

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

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

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)
                              throws IllegalArgumentException,
SourceUnavailableException

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)

findByIds

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

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)

findByIdsOrIdentifiers

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

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,
 String source)
                                           throws IllegalArgumentException,
SourceUnavailableException

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)

findByIdsOrIdentifiers

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

sources - Source adapters 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, Set)