# Uses of Interface
org.opensaml.saml.metadata.resolver.index.MetadataIndexKey

Packages that use MetadataIndexKey
Package
Description
org.opensaml.saml.metadata.resolver.index
Classes for SAML metadata indexing.
org.opensaml.saml.metadata.resolver.index.impl
Implementation of the metadata resolver indexes.

## Uses of MetadataIndexKey in org.opensaml.saml.metadata.resolver.index

Classes in org.opensaml.saml.metadata.resolver.index that implement MetadataIndexKey
Modifier and Type
Class
Description
`class`
`SimpleStringMetadataIndexKey`
A simple implementation of `MetadataIndexKey` based on a single input string.
Methods in org.opensaml.saml.metadata.resolver.index that return types with arguments of type MetadataIndexKey
Modifier and Type
Method
Description
`Set<MetadataIndexKey>`
MetadataIndex.`generateKeys(CriteriaSet criteriaSet)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `CriteriaSet`.
`Set<MetadataIndexKey>`
MetadataIndex.`generateKeys(EntityDescriptor descriptor)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `EntityDescriptor`.

## Uses of MetadataIndexKey in org.opensaml.saml.metadata.resolver.index.impl

Classes in org.opensaml.saml.metadata.resolver.index.impl that implement MetadataIndexKey
Modifier and Type
Class
Description
`protected static class`
`EndpointMetadataIndex.EndpointMetadataIndexKey`
An implementation of `MetadataIndexKey` representing a single SAML metadata endpoint.
`protected static class`
`RoleMetadataIndex.RoleMetadataIndexKey`
An implementation of `MetadataIndexKey` representing a single SAML metadata role.
`protected static class`
`SAMLArtifactMetadataIndex.ArtifactSourceIDMetadataIndexKey`
An implementation of `MetadataIndexKey` representing a SAML artifact SourceID value.
`protected static class`
`SAMLArtifactMetadataIndex.ArtifactSourceLocationMetadataIndexKey`
An implementation of `MetadataIndexKey` representing a SAML artifact source location value.
Fields in org.opensaml.saml.metadata.resolver.index.impl with type parameters of type MetadataIndexKey
Modifier and Type
Field
Description
`private Function<CriteriaSet,Set<MetadataIndexKey>>`
FunctionDrivenMetadataIndex.`criteriaStrategy`
Function for producing index keys from a CriteriaSet.
`private Function<EntityDescriptor,Set<MetadataIndexKey>>`
FunctionDrivenMetadataIndex.`descriptorStrategy`
Function for producing index keys from an EntityDescriptor.
`private final Map<MetadataIndexKey,Set<T>>`
MetadataIndexStore.`index`
The indexed storage of data.
`private List<Function<EntityDescriptor,Set<MetadataIndexKey>>>`
SAMLArtifactMetadataIndex.`indexingFunctions`
Indexing function instance to use.
Methods in org.opensaml.saml.metadata.resolver.index.impl that return types with arguments of type MetadataIndexKey
Modifier and Type
Method
Description
`Set<MetadataIndexKey>`
SAMLArtifactMetadataIndex.EntityIDToSHA1SourceIDIndexingFunction.`apply(EntityDescriptor descriptor)`
`Set<MetadataIndexKey>`
SAMLArtifactMetadataIndex.SourceIDExtensionIndexingFunction.`apply(EntityDescriptor descriptor)`
`Set<MetadataIndexKey>`
SAMLArtifactMetadataIndex.SourceLocationIndexingFunction.`apply(EntityDescriptor descriptor)`
`Set<MetadataIndexKey>`
EndpointMetadataIndex.`generateKeys(CriteriaSet criteriaSet)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `CriteriaSet`.
`Set<MetadataIndexKey>`
EndpointMetadataIndex.`generateKeys(EntityDescriptor descriptor)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `EntityDescriptor`.
`Set<MetadataIndexKey>`
FunctionDrivenMetadataIndex.`generateKeys(CriteriaSet criteriaSet)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `CriteriaSet`.
`Set<MetadataIndexKey>`
FunctionDrivenMetadataIndex.`generateKeys(EntityDescriptor descriptor)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `EntityDescriptor`.
`Set<MetadataIndexKey>`
RoleMetadataIndex.`generateKeys(CriteriaSet criteriaSet)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `CriteriaSet`.
`Set<MetadataIndexKey>`
RoleMetadataIndex.`generateKeys(EntityDescriptor descriptor)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `EntityDescriptor`.
`Set<MetadataIndexKey>`
SAMLArtifactMetadataIndex.`generateKeys(CriteriaSet criteriaSet)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `CriteriaSet`.
`Set<MetadataIndexKey>`
SAMLArtifactMetadataIndex.`generateKeys(EntityDescriptor descriptor)`
Generate a set of one or more `MetadataIndexKey` instances based on the input `EntityDescriptor`.
`Set<MetadataIndexKey>`
MetadataIndexStore.`getKeys()`
Get the set of all `MetadataIndexKey` instances currently indexed.
`private Set<MetadataIndexKey>`
EndpointMetadataIndex.`processCriteria(CriteriaSet criteriaSet, QName roleType, Endpoint endpoint)`
Process the specified role and endpoint.
Methods in org.opensaml.saml.metadata.resolver.index.impl with parameters of type MetadataIndexKey
Modifier and Type
Method
Description
`void`
MetadataIndexStore.`add(MetadataIndexKey key, T item)`
Add the supplied data item to the index under the supplied `MetadataIndexKey`.
`void`
MetadataIndexStore.`clear(MetadataIndexKey key)`
Clear all data items indexed under the supplied `MetadataIndexKey`.
`Set<T>`
MetadataIndexStore.`lookup(MetadataIndexKey key)`
Lookup the instances of data indexed under the supplied `MetadataIndexKey`.
`void`
MetadataIndexStore.`remove(MetadataIndexKey key, T item)`
Remove the supplied data item from the index under the supplied `MetadataIndexKey`.
Constructor parameters in org.opensaml.saml.metadata.resolver.index.impl with type arguments of type MetadataIndexKey
Modifier
Constructor
Description
``
`FunctionDrivenMetadataIndex(Function<EntityDescriptor,Set<MetadataIndexKey>> descriptorFunction, Function<CriteriaSet,Set<MetadataIndexKey>> criteriaFunction)`
Constructor.
``
`SAMLArtifactMetadataIndex(List<Function<EntityDescriptor,Set<MetadataIndexKey>>> descriptorIndexingFunctions)`
Constructor.