net.shibboleth.idp.attribute.resolver

Class PluginDependencySupport

java.lang.Object

net.shibboleth.idp.attribute.resolver.PluginDependencySupport

public final class PluginDependencySupport
extends Object

Support class for working with ResolverPluginDependency.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PluginDependencySupport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private static void	addAttributeValues(IdPAttribute source, Map<String,Set<IdPAttributeValue<?>>> target) Adds the values of the given attribute to the target collection of attribute values.
private static void	addAttributeValues(IdPAttribute source, Set<IdPAttributeValue<?>> target) Adds the values of the given attribute to the set of attribute values.
private static void	addAttributeValues(Map<String,IdPAttribute> sources, Map<String,Set<IdPAttributeValue<?>>> target) Adds the values of the attributes to the target collection of attribute values indexes by attribute ID.
static Map<String,Set<IdPAttributeValue<?>>>	getAllAttributeValues(AttributeResolverWorkContext workContext, Collection<ResolverPluginDependency> dependencies) Gets the values from all dependencies.
static Set<IdPAttributeValue<?>>	getMergedAttributeValues(AttributeResolverWorkContext workContext, Collection<ResolverPluginDependency> dependencies) Gets the values, as a single set, from all dependencies.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDependencySupport

private PluginDependencySupport()

Constructor.

Method Detail

getMergedAttributeValues

@Nonnull
@NonnullElements
public static Set<IdPAttributeValue<?>> getMergedAttributeValues(@Nonnull
                                                                         AttributeResolverWorkContext workContext,
                                                                         @Nonnull@NonnullElements
                                                                         Collection<ResolverPluginDependency> dependencies)

Gets the values, as a single set, from all dependencies. This method only supports dependencies which contain an attribute specifier (i.e. ResolverPluginDependency.getDependencyAttributeId() does not equal null). It is therefore used inside Attribute definitions which only process a single attribute as input.

NOTE, this method does *not* actually trigger any attribute definition or data connector resolution, it only looks for the cached results of previously resolved plugins within the current work context.

Parameters:

workContext - current attribute resolver work context

dependencies - set of dependencies

Returns:

the merged value set

getAllAttributeValues

public static Map<String,Set<IdPAttributeValue<?>>> getAllAttributeValues(@Nonnull
                                                          AttributeResolverWorkContext workContext,
                                                          @Nonnull
                                                          Collection<ResolverPluginDependency> dependencies)

Gets the values from all dependencies. Attributes, with the same identifier but from different resolver plugins, will have their values merged into a single set within this method's returned map. This method is the equivalent of calling getMergedAttributeValues(AttributeResolverWorkContext, Collection) for all attributes resolved by all the given dependencies. This is therefore used when an attribute definition may have multiple input attributes (for instance scripted or templated definitions).

NOTE, this method does *not* actually trigger any attribute definition or data connector resolution, it only looks for the cached results of previously resolved plugins within the current work context.

Parameters:

workContext - current attribute resolver work context

dependencies - set of dependencies

Returns:

the merged value set

addAttributeValues

@Nonnull
private static void addAttributeValues(@Nonnull
                              Map<String,IdPAttribute> sources,
                              @Nullable
                              Map<String,Set<IdPAttributeValue<?>>> target)

Adds the values of the attributes to the target collection of attribute values indexes by attribute ID.

Parameters:

sources - the source attributes

target - current set attribute values

addAttributeValues

@Nonnull
private static void addAttributeValues(@Nullable
                              IdPAttribute source,
                              @Nullable
                              Map<String,Set<IdPAttributeValue<?>>> target)

Adds the values of the given attribute to the target collection of attribute values.

Parameters:

source - the source attribute

target - current set attribute values

addAttributeValues

@Nonnull
private static void addAttributeValues(@Nullable
                              IdPAttribute source,
                              @Nonnull
                              Set<IdPAttributeValue<?>> target)

Adds the values of the given attribute to the set of attribute values.

Parameters:

source - the source attribute

target - current set attribute values