Package org.opensaml.saml.metadata.resolver.index.impl

Class FunctionDrivenMetadataIndex

java.lang.Object

org.opensaml.saml.metadata.resolver.index.impl.FunctionDrivenMetadataIndex

All Implemented Interfaces:

MetadataIndex

public class FunctionDrivenMetadataIndex
extends Object
implements MetadataIndex

Implementation of MetadataIndex which is based on injected strategy functions.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<CriteriaSet,Set<MetadataIndexKey>>	criteriaStrategy	Function for producing index keys from a CriteriaSet.
private Function<EntityDescriptor,Set<MetadataIndexKey>>	descriptorStrategy	Function for producing index keys from an EntityDescriptor.

Constructor Summary

Constructors

Constructor	Description
FunctionDrivenMetadataIndex(Function<EntityDescriptor,Set<MetadataIndexKey>> descriptorFunction, Function<CriteriaSet,Set<MetadataIndexKey>> criteriaFunction)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<MetadataIndexKey>	generateKeys(CriteriaSet criteriaSet)	Generate a set of one or more MetadataIndexKey instances based on the input CriteriaSet.
Set<MetadataIndexKey>	generateKeys(EntityDescriptor descriptor)	Generate a set of one or more MetadataIndexKey instances based on the input EntityDescriptor.

Methods inherited from class java.lang.Object

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

Field Details

criteriaStrategy

@Nonnull
private Function<CriteriaSet,Set<MetadataIndexKey>> criteriaStrategy

Function for producing index keys from a CriteriaSet.

descriptorStrategy

@Nonnull
private Function<EntityDescriptor,Set<MetadataIndexKey>> descriptorStrategy

Function for producing index keys from an EntityDescriptor.

Constructor Details

FunctionDrivenMetadataIndex

public FunctionDrivenMetadataIndex(@Nonnull
 Function<EntityDescriptor,Set<MetadataIndexKey>> descriptorFunction,
 @Nonnull
 Function<CriteriaSet,Set<MetadataIndexKey>> criteriaFunction)

Constructor.

Parameters:

descriptorFunction - function for producing index keys from an EntityDescriptor

criteriaFunction - function for producing index keys from a CriteriaSet

Method Details

generateKeys

@Nullable
@Unmodifiable
@NotLive
public Set<MetadataIndexKey> generateKeys(@Nullable
 CriteriaSet criteriaSet)

Generate a set of one or more MetadataIndexKey instances based on the input CriteriaSet.

These index key instances reflect the type of indexing performed and "understood" by the implementation, and as such should complement the MetadataIndexKey types generated for descriptor indexing via MetadataIndex.generateKeys(EntityDescriptor).

Specified by:

generateKeys in interface MetadataIndex

Parameters:

criteriaSet - the criteria set to process

Returns:

the set of index keys generated from the criteria. May be null or empty, but will not contain null elements.

generateKeys

@Nullable
@Unmodifiable
@NotLive
public Set<MetadataIndexKey> generateKeys(@Nonnull
 EntityDescriptor descriptor)

Generate a set of one or more MetadataIndexKey instances based on the input EntityDescriptor.

These index key instances reflect the type of indexing performed and "understood" by the implementation, and as such should complement the MetadataIndexKey types generated for descriptor lookup via MetadataIndex.generateKeys(CriteriaSet).

Specified by:

generateKeys in interface MetadataIndex

Parameters:

descriptor - the entity descriptor set to process

Returns:

the set of index keys generated from the criteria. May be null or empty, but will not contain null elements.