net.shibboleth.idp.attribute.resolver.impl

Class AttributeResolverImpl

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.ext.spring.service.AbstractServiceableComponent<AttributeResolver>

net.shibboleth.idp.attribute.resolver.impl.AttributeResolverImpl

All Implemented Interfaces:

AttributeResolver, LegacyPrincipalDecoder, Component, DestructableComponent, IdentifiedComponent, InitializableComponent, ServiceableComponent<AttributeResolver>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@ThreadSafe
public class AttributeResolverImpl
extends AbstractServiceableComponent<AttributeResolver>
implements AttributeResolver, LegacyPrincipalDecoder

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 Resolver which in about summoning up bits of generic data from the configuration (usually the metadata) in response to specific Criterions.
The implementation also implements LegacyPrincipalDecoder in support of the deprecated <PrincipalConnector>

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,AttributeDefinition>	attributeDefinitions Attribute definitions defined for this resolver.
private Map<String,DataConnector>	dataConnectors Data connectors defined for this resolver.
private org.slf4j.Logger	log Class logger.
private String	logPrefix cache for the log prefix - to save multiple recalculations.
private LegacyPrincipalDecoder	principalConnector The Principal mapper.
private Function<AttributeResolutionContext,org.opensaml.profile.context.ProfileRequestContext>	profileContextStrategy Strategy to get the ProfileRequestContext.

Constructor Summary

Constructors

Constructor and Description
AttributeResolverImpl() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	canonicalize(SubjectCanonicalizationContext context)
protected void	checkPlugInDependencies(String circularCheckPluginId, ResolverPlugin<?> plugin, Set<String> checkedPlugins) Checks to ensure that there are no circular dependencies or dependencies on non-existent plugins.
protected void	doInitialize()
protected void	finalizeResolvedAttributes(AttributeResolutionContext resolutionContext) Finalizes the set of resolved attributes and places them in the AttributeResolutionContext.
Map<String,AttributeDefinition>	getAttributeDefinitions() Gets the collection of attribute definitions for this resolver.
AttributeResolver	getComponent()
Map<String,DataConnector>	getDataConnectors() Gets the unmodifiable collection of data connectors for this resolver.
protected Collection<String>	getToBeResolvedAttributeIds(AttributeResolutionContext resolutionContext) Gets the list of attributes, identified by IDs, that should be resolved.
boolean	hasValidConnectors()
protected void	resolveAttributeDefinition(String attributeId, AttributeResolutionContext resolutionContext) Resolve the AttributeDefinition which has the specified ID.
void	resolveAttributes(AttributeResolutionContext resolutionContext) Resolves the attribute for the given request.
protected void	resolveDataConnector(String connectorId, AttributeResolutionContext resolutionContext) Resolve the DataConnector which has the specified ID.
protected void	resolveDependencies(ResolverPlugin<?> plugin, AttributeResolutionContext resolutionContext) Resolves all the dependencies for a given plugin.
void	setAttributeDefinitions(Collection<AttributeDefinition> definitions) Sets the attribute definitions for this resolver.
void	setDataConnectors(Collection<DataConnector> connectors) Sets the data connectors for this resolver.
void	setId(String resolverId)
void	setPrincipalDecoder(LegacyPrincipalDecoder principalResolver) Set the Decoder.
void	setProfileContextLookupStrategy(Function<AttributeResolutionContext,org.opensaml.profile.context.ProfileRequestContext> strategy) Set the mechanism to obtain the ProfileRequestContext.
private boolean	startTimer(AttributeResolutionContext resolutionContext) Conditionally start a timer at the beginning of the resolution process.
private void	stopTimer(AttributeResolutionContext resolutionContext) Conditionally stop a timer at the end of the resolution process.

Methods inherited from class net.shibboleth.ext.spring.service.AbstractServiceableComponent

doDestroy, getApplicationContext, pinComponent, setApplicationContext, unloadComponent, unpinComponent

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

attributeDefinitions

@NonnullAfterInit
private Map<String,AttributeDefinition> attributeDefinitions

Attribute definitions defined for this resolver.

dataConnectors

@NonnullAfterInit
private Map<String,DataConnector> dataConnectors

Data connectors defined for this resolver.

logPrefix

@NonnullAfterInit
private String logPrefix

cache for the log prefix - to save multiple recalculations.

principalConnector

@Nullable
private LegacyPrincipalDecoder principalConnector

The Principal mapper.

profileContextStrategy

@Nonnull
private Function<AttributeResolutionContext,org.opensaml.profile.context.ProfileRequestContext> profileContextStrategy

Strategy to get the ProfileRequestContext.

Constructor Detail

AttributeResolverImpl

public AttributeResolverImpl()

Constructor.

Method Detail

setId

public void setId(@Nonnull@NotEmpty
         String resolverId)

Overrides:

setId in class AbstractIdentifiedInitializableComponent

setAttributeDefinitions

public void setAttributeDefinitions(@Nullable@NullableElements
                           Collection<AttributeDefinition> definitions)

Sets the attribute definitions for this resolver.

Parameters:

definitions - attribute definitions loaded in to this resolver

getAttributeDefinitions

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

Gets the collection of attribute definitions for this resolver.

Specified by:

getAttributeDefinitions in interface AttributeResolver

Returns:

attribute definitions loaded in to this resolver

setDataConnectors

public void setDataConnectors(@Nullable@NullableElements
                     Collection<DataConnector> connectors)

Sets the data connectors for this resolver.

Parameters:

connectors - data connectors loaded in to this resolver

getDataConnectors

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

Gets the unmodifiable collection of data connectors for this resolver.

Specified by:

getDataConnectors in interface AttributeResolver

Returns:

data connectors loaded in to this resolver

setPrincipalDecoder

public void setPrincipalDecoder(@Nullable
                       LegacyPrincipalDecoder principalResolver)

Set the Decoder.

Parameters:

principalResolver - code to resolve the principal

setProfileContextLookupStrategy

public void setProfileContextLookupStrategy(@Nonnull
                                   Function<AttributeResolutionContext,org.opensaml.profile.context.ProfileRequestContext> strategy)

Set the mechanism to obtain the ProfileRequestContext.

Parameters:

strategy - lookup strategy

resolveAttributes

public void resolveAttributes(@Nonnull
                     AttributeResolutionContext resolutionContext)
                       throws ResolutionException

Resolves the attribute for the given request. Note, if attributes are requested, AttributeResolutionContext.getRequestedIdPAttributeNames(), 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.

Specified by:

resolveAttributes in interface AttributeResolver

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

getToBeResolvedAttributeIds

@Nonnull
@NonnullElements
protected Collection<String> getToBeResolvedAttributeIds(@Nonnull
                                                                     AttributeResolutionContext resolutionContext)

Gets the list of attributes, identified by IDs, that should be resolved. If the AttributeResolutionContext.getRequestedIdPAttributeNames() is not empty then those attributes are the ones to be resolved, otherwise all registered attribute definitions are to be resolved.

Parameters:

resolutionContext - current resolution context

Returns:

list of attributes, identified by IDs, that should be resolved

resolveAttributeDefinition

protected void resolveAttributeDefinition(@Nonnull
                              String attributeId,
                              @Nonnull
                              AttributeResolutionContext resolutionContext)
                                   throws ResolutionException

Resolve the AttributeDefinition which has the specified ID. The results of the resolution are stored in the given AttributeResolutionContext.

Parameters:

attributeId - id of the attribute definition to resolve

resolutionContext - resolution context that we are working in

Throws:

ResolutionException - if unable to resolve the requested attribute definition

resolveDataConnector

protected void resolveDataConnector(@Nonnull
                        String connectorId,
                        @Nonnull
                        AttributeResolutionContext resolutionContext)
                             throws ResolutionException

Resolve the DataConnector which has the specified ID. The results of the resolution are stored in the given AttributeResolutionContext.

Parameters:

connectorId - id of the data connector to resolve

resolutionContext - resolution context that we are working in

Throws:

ResolutionException - if unable to resolve the requested connector

resolveDependencies

protected void resolveDependencies(@Nonnull
                       ResolverPlugin<?> plugin,
                       @Nonnull
                       AttributeResolutionContext resolutionContext)
                            throws ResolutionException

Resolves all the dependencies for a given plugin.

Parameters:

plugin - plugin whose dependencies should be resolved

resolutionContext - current resolution context

Throws:

ResolutionException - thrown if there is a problem resolving a dependency

finalizeResolvedAttributes

protected void finalizeResolvedAttributes(@Nonnull
                              AttributeResolutionContext resolutionContext)

Finalizes the set of resolved attributes and places them in the AttributeResolutionContext. The result of each AttributeDefinition resolution is inspected. If the result is not null, a dependency-only attribute, or an attribute that contains no values then it becomes part of the final set of resolved attributes.

Values are also de-duplicated here, so that all the intermediate operations maintain the coherency of multi-valued result sets produced by data connectors.

Parameters:

resolutionContext - current resolution context

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractServiceableComponent<AttributeResolver>

Throws:

ComponentInitializationException

checkPlugInDependencies

protected void checkPlugInDependencies(String circularCheckPluginId,
                           ResolverPlugin<?> plugin,
                           Set<String> checkedPlugins)
                                throws ComponentInitializationException

Checks to ensure that there are no circular dependencies or dependencies on non-existent plugins.

Parameters:

circularCheckPluginId - the ID of the plugin currently being checked for circular dependencies

plugin - current plugin, in the dependency tree of the plugin being checked, that we're currently looking at

checkedPlugins - IDs of plugins that have already been checked and known to be good

Throws:

ComponentInitializationException - thrown if there is a dependency loop

getComponent

@Nonnull
public AttributeResolver getComponent()

Specified by:

getComponent in interface ServiceableComponent<AttributeResolver>

Specified by:

getComponent in class AbstractServiceableComponent<AttributeResolver>

canonicalize

@Nullable
public String canonicalize(@Nonnull
                           SubjectCanonicalizationContext context)
                    throws ResolutionException

Specified by:

canonicalize in interface LegacyPrincipalDecoder

Throws:

ResolutionException

hasValidConnectors

public boolean hasValidConnectors()

Specified by:

hasValidConnectors in interface LegacyPrincipalDecoder

startTimer

private boolean startTimer(@Nonnull
                 AttributeResolutionContext resolutionContext)

Conditionally start a timer at the beginning of the resolution process.

Parameters:

resolutionContext - attribute resolution context

Returns:

true iff the stopTimer(AttributeResolutionContext) method needs to be called

stopTimer

private void stopTimer(@Nonnull
             AttributeResolutionContext resolutionContext)

Conditionally stop a timer at the end of the resolution process.

Parameters:

resolutionContext - attribute resolution context