net.shibboleth.idp.attribute.resolver

Interface AttributeResolver

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent

@ThreadSafe
public interface AttributeResolver
extends net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent

A component that resolves the attributes for a particular subject.

Note WellThis class is about attribute resolution, that is to say the summoning up of attributes in response to the exigies of the provided context. It does not implement net.shibboleth.utilities.java.support.resolver.Resolver which is about summoning up bits of generic data from the configuration (e.g., metadata) in response to specific net.shibboleth.utilities.java.support.resolver.Criterions.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,AttributeDefinition>	getAttributeDefinitions() Gets the collection of attribute definitions for this resolver.
Map<String,DataConnector>	getDataConnectors() Gets the unmodifiable collection of data connectors for this resolver.
void	resolveAttributes(AttributeResolutionContext resolutionContext) Resolves the attribute for the give request.

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Method Detail

getAttributeDefinitions

@Nonnull
@NonnullElements
@Unmodifiable
Map<String,AttributeDefinition> getAttributeDefinitions()

Gets the collection of attribute definitions for this resolver.

Returns:

attribute definitions loaded in to this resolver

getDataConnectors

@Nonnull
@NonnullElements
@Unmodifiable
Map<String,DataConnector> getDataConnectors()

Gets the unmodifiable collection of data connectors for this resolver.

Returns:

data connectors loaded in to this resolver

resolveAttributes

void resolveAttributes(@Nonnull
                     AttributeResolutionContext resolutionContext)
                       throws ResolutionException

Resolves the attribute for the give request. Note, if attributes are requested, AttributeResolutionContext#getRequestedIdPAttributes(), the resolver will not fail if they can not be resolved. This information serves only as a hint to the resolver to, potentially, optimize the resolution of attributes.

Parameters:

resolutionContext - the attribute resolution context that identifies the request subject and accumulates the resolved attributes

Throws:

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