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.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG Log.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PluginDependencySupport() Constructor.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Log.

Constructor Detail

PluginDependencySupport

private PluginDependencySupport()

Constructor.

Method Detail

getMergedAttributeValues

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

Deprecated. use getMergedAttributeValues( AttributeResolverWorkContext, Collection, String)

Gets the values, as a single list, 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. Returns an empty set if we were given a DataConnector as a dependency, but not attribute name

getMergedAttributeValues

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

Gets the values, as a single list, 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

attributeDefinitionId - the attributeID that these values will be associated with.

Returns:

the merged value set. Returns an empty set if we were given a DataConnector as a dependency, but not attribute name

getAllAttributeValues

public static Map<String,List<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 list 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

mergeAttributes

@Nonnull
private static void mergeAttributes(@Nonnull
                           Map<String,IdPAttribute> sources,
                           @Nullable
                           Map<String,List<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

addAttribute

@Nonnull
private static void addAttribute(@Nullable
                        IdPAttribute source,
                        @Nullable
                        Map<String,List<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

mergeAttributeValues

@Nonnull
private static void mergeAttributeValues(@Nullable
                                IdPAttribute source,
                                @Nonnull
                                List<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