edu.internet2.middleware.shibboleth.common.attribute.resolver

Interface AttributeResolver<RequestContextType extends AttributeRequestContext>

Type Parameters:

RequestContextType - the type of attribute request context used by the resolver.

All Known Implementing Classes:

ShibbolethAttributeResolver

public interface AttributeResolver<RequestContextType extends AttributeRequestContext>

The service that resolves the attributes for a particular subject.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,BaseAttribute>	resolveAttributes(RequestContextType requestContext) Gets all the attributes for a given subject.
void	validate() Check that the Attribute Resolver is in a valid state and ready to begin receiving resolution requests.

Method Detail

resolveAttributes

Map<String,BaseAttribute> resolveAttributes(RequestContextType requestContext)
                                            throws AttributeResolutionException

Gets all the attributes for a given subject. While an initial attribute producer is given this does not mean every returned attribute is from that producer. The producer may return information that can be used by data connectors to contact other producers and retrieve attributes from them.

Parameters:

requestContext - the attribute resolution context to use to resolve attributes

Returns:

the attributes describing the subject

Throws:

AttributeResolutionException - thrown if there is a problem resolving the attributes for the subject

validate

void validate()
              throws AttributeResolutionException

Check that the Attribute Resolver is in a valid state and ready to begin receiving resolution requests.

Throws:

AttributeResolutionException - if resolver is in an invalid state