edu.internet2.middleware.grouper.subj
Class CachingResolver

java.lang.Object
  extended by edu.internet2.middleware.grouper.subj.SubjectResolverDecorator
      extended by 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 $
Author:
blair christensen.

Constructor Summary
CachingResolver(SubjectResolver resolver)
           
 
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)
           
 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 id)
           
 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()
           
 
Methods inherited from class edu.internet2.middleware.grouper.subj.SubjectResolverDecorator
getDecoratedResolver
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CachingResolver

public CachingResolver(SubjectResolver resolver)
Since:
1.2.1
Method Detail

flushCache

public void flushCache()
flush the cache (e.g. for testing)


find

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
Parameters:
id - Subject id to search on.
Returns:
Subject matching search parameters.
Throws:
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.
Since:
1.2.1
See Also:
SubjectResolver.find(String)

find

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
Parameters:
id - Subject id to search on.
source - Source adapter to search within.
Returns:
Subject matching search parameters.
Throws:
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.
Since:
1.2.1
See Also:
SubjectResolver.find(String, String)

findAll

public java.util.Set<edu.internet2.middleware.subject.Subject> findAll(java.lang.String query)
                                                                throws java.lang.IllegalArgumentException
Parameters:
query - A source-appropraite query string.
Returns:
All subjects matching query.
Throws:
java.lang.IllegalArgumentException - if any parameter is null.
Since:
1.2.1
See Also:
SubjectResolver.findAll(String)

findAll

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
Parameters:
query - A source-appropriate query string.
source - Restrict query to within this source.
Returns:
All subjects matching query.
Throws:
java.lang.IllegalArgumentException - if any parameter is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source is unavailable.
Since:
1.2.1
See Also:
SubjectResolver.findAll(String, String)

findByIdentifier

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
Parameters:
id - Subject identifier to search on.
Returns:
Subject matching search parameters.
Throws:
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.
Since:
1.2.1
See Also:
SubjectResolver.findByIdentifier(String)

findByIdentifier

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
Parameters:
id - Subject identifier to search on.
source - Source adapter to search within.
Returns:
Subject matching search parameters.
Throws:
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.
Since:
1.2.1
See Also:
SubjectResolver.findByIdentifier(String, String)

getSource

public edu.internet2.middleware.subject.Source getSource(java.lang.String id)
                                                  throws java.lang.IllegalArgumentException,
                                                         edu.internet2.middleware.subject.SourceUnavailableException
Returns:
Subject source identified by id.
Throws:
java.lang.IllegalArgumentException - if id is null.
edu.internet2.middleware.subject.SourceUnavailableException - if source cannot be returned.
Since:
1.2.1
See Also:
SubjectResolver.getSource(String)

getSources

public java.util.Set<edu.internet2.middleware.subject.Source> getSources()
Returns:
All Subject sources.
Since:
1.2.1
See Also:
SubjectResolver.getSources()

findByIdOrIdentifier

public edu.internet2.middleware.subject.Subject findByIdOrIdentifier(java.lang.String id)
                                                              throws java.lang.IllegalArgumentException,
                                                                     edu.internet2.middleware.subject.SubjectNotFoundException,
                                                                     edu.internet2.middleware.subject.SubjectNotUniqueException
Parameters:
id - Subject identifier to search on.
Returns:
Subject matching search parameters.
Throws:
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.

findByIdOrIdentifier

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
Parameters:
id - Subject identifier to search on.
source - Source adapter to search within.
Returns:
Subject matching search parameters.
Throws:
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.
See Also:
SubjectResolver.findByIdOrIdentifier(String, String)

findAllInStem

public java.util.Set<edu.internet2.middleware.subject.Subject> findAllInStem(java.lang.String stemName,
                                                                             java.lang.String query)
                                                                      throws java.lang.IllegalArgumentException
Parameters:
stemName - name of stem we are querying
query - A source-appropriate query string.
Returns:
All subjects matching query.
Throws:
java.lang.IllegalArgumentException - if any parameter is null.
See Also:
SubjectResolver.findAllInStem(java.lang.String, java.lang.String)