edu.internet2.middleware.grouper.subj
Class ValidatingResolver

java.lang.Object
  edu.internet2.middleware.grouper.subj.SubjectResolverDecorator
      edu.internet2.middleware.grouper.subj.ValidatingResolver

All Implemented Interfaces:

SubjectResolver

public class ValidatingResolver
extends SubjectResolverDecorator

Decorator that provides parameter validation for SubjectResolver.

Since:

1.2.1

Version:

$Id: ValidatingResolver.java,v 1.7 2008/08/26 21:11:51 mchyzer Exp $

Author:

blair christensen.

Constructor Summary

ValidatingResolver(SubjectResolver resolver)

Method Summary

edu.internet2.middleware.subject.Subject	find(String id)
edu.internet2.middleware.subject.Subject	find(String id, String type)
edu.internet2.middleware.subject.Subject	find(String id, String type, String source)
Set<edu.internet2.middleware.subject.Subject>	findAll(String query)
Set<edu.internet2.middleware.subject.Subject>	findAll(String query, String source)
edu.internet2.middleware.subject.Subject	findByIdentifier(String id)
edu.internet2.middleware.subject.Subject	findByIdentifier(String id, String type)
edu.internet2.middleware.subject.Subject	findByIdentifier(String id, String type, String source)
void	flushCache() flush the cache (e.g.
edu.internet2.middleware.subject.Source	getSource(String id)
Set<edu.internet2.middleware.subject.Source>	getSources()
Set<edu.internet2.middleware.subject.Source>	getSources(String subjectType)

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

ValidatingResolver

public ValidatingResolver(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(String id)
                                              throws IllegalArgumentException,
                                                     edu.internet2.middleware.subject.SubjectNotFoundException,
                                                     edu.internet2.middleware.subject.SubjectNotUniqueException

Parameters:

id - Subject id to search on.

Returns:

Subject matching search parameters.

Throws:

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(String id,
                                                     String type)
                                              throws IllegalArgumentException,
                                                     edu.internet2.middleware.subject.SubjectNotFoundException,
                                                     edu.internet2.middleware.subject.SubjectNotUniqueException

Parameters:

id - Subject id to search on.

type - Subject type to search on.

Returns:

Subject matching search parameters.

Throws:

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

find

public edu.internet2.middleware.subject.Subject find(String id,
                                                     String type,
                                                     String source)
                                              throws IllegalArgumentException,
                                                     edu.internet2.middleware.subject.SourceUnavailableException,
                                                     edu.internet2.middleware.subject.SubjectNotFoundException,
                                                     edu.internet2.middleware.subject.SubjectNotUniqueException

Parameters:

id - Subject id to search on.

type - Subject type to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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

findAll

public Set<edu.internet2.middleware.subject.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<edu.internet2.middleware.subject.Subject> findAll(String query,
                                                             String source)
                                                      throws 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:

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(String id)
                                                          throws IllegalArgumentException,
                                                                 edu.internet2.middleware.subject.SubjectNotFoundException,
                                                                 edu.internet2.middleware.subject.SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

Returns:

Subject matching search parameters.

Throws:

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(String id,
                                                                 String type)
                                                          throws IllegalArgumentException,
                                                                 edu.internet2.middleware.subject.SubjectNotFoundException,
                                                                 edu.internet2.middleware.subject.SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

type - Subject type to search on.

Returns:

Subject matching search parameters.

Throws:

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

findByIdentifier

public edu.internet2.middleware.subject.Subject findByIdentifier(String id,
                                                                 String type,
                                                                 String source)
                                                          throws IllegalArgumentException,
                                                                 edu.internet2.middleware.subject.SourceUnavailableException,
                                                                 edu.internet2.middleware.subject.SubjectNotFoundException,
                                                                 edu.internet2.middleware.subject.SubjectNotUniqueException

Parameters:

id - Subject identifier to search on.

type - Subject type to search on.

source - Source adapter to search within.

Returns:

Subject matching search parameters.

Throws:

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

getSource

public edu.internet2.middleware.subject.Source getSource(String id)
                                                  throws IllegalArgumentException,
                                                         edu.internet2.middleware.subject.SourceUnavailableException

Returns:

Subject source identified by id.

Throws:

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 Set<edu.internet2.middleware.subject.Source> getSources()

Returns:

All Subject sources.

Since:

1.2.1

See Also:

SubjectResolver.getSources()

getSources

public Set<edu.internet2.middleware.subject.Source> getSources(String subjectType)
                                                        throws IllegalArgumentException

Parameters:

subjectType - Only return sources that provide this type.

Returns:

All Subject sources that provide subjectType.

Throws:

IllegalArgumentException - if subjectType is null or invalid.

Since:

1.2.1

See Also:

SubjectResolver.getSources(String)