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

Class SAMLArtifactMetadataIndex

java.lang.Object

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

All Implemented Interfaces:

org.opensaml.saml.metadata.resolver.index.MetadataIndex

public class SAMLArtifactMetadataIndex
extends Object
implements org.opensaml.saml.metadata.resolver.index.MetadataIndex

An implementation of MetadataIndex which indexes entities by their artifact SourceID values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
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.
static class	SAMLArtifactMetadataIndex.EntityIDToSHA1SourceIDIndexingFunction	Entity descriptor indexing function which produces a single SAMLArtifactMetadataIndex.ArtifactSourceIDMetadataIndexKey based on the SHA-1 digest of the UTF-8 encoding of the value of EntityDescriptor.getEntityID().
static class	SAMLArtifactMetadataIndex.SourceIDExtensionIndexingFunction	Descriptor indexing function which produces 0 to many SAMLArtifactMetadataIndex.ArtifactSourceIDMetadataIndexKey instances based on the values of all SourceID extension elements present in the descriptor's RoleDescriptors.
static class	SAMLArtifactMetadataIndex.SourceLocationIndexingFunction	Descriptor indexing function which produces 0 to many SAMLArtifactMetadataIndex.ArtifactSourceLocationMetadataIndexKey instances based on the location values of all ArtifactResolutionService elements present in the descriptor's RoleDescriptors.

Field Summary

Fields

Modifier and Type	Field	Description
private List<Function<org.opensaml.saml.saml2.metadata.EntityDescriptor,Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>>>	indexingFunctions	Indexing function instance to use.

Constructor Summary

Constructors

Constructor	Description
SAMLArtifactMetadataIndex()	Constructor.
SAMLArtifactMetadataIndex(List<Function<org.opensaml.saml.saml2.metadata.EntityDescriptor,Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>>> descriptorIndexingFunctions)	Constructor.

Method Summary

Modifier and Type	Method	Description
Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>	generateKeys(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>	generateKeys(org.opensaml.saml.saml2.metadata.EntityDescriptor descriptor)

Methods inherited from class java.lang.Object

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

Field Detail

indexingFunctions

@Nonnull
@NonnullElements
private List<Function<org.opensaml.saml.saml2.metadata.EntityDescriptor,Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>>> indexingFunctions

Indexing function instance to use.

Constructor Detail

SAMLArtifactMetadataIndex

public SAMLArtifactMetadataIndex()

Constructor.

The descriptor indexing functions will be:

• SAMLArtifactMetadataIndex.EntityIDToSHA1SourceIDIndexingFunction
• SAMLArtifactMetadataIndex.SourceIDExtensionIndexingFunction
• SAMLArtifactMetadataIndex.SourceLocationIndexingFunction

SAMLArtifactMetadataIndex

public SAMLArtifactMetadataIndex(@Nonnull
                                 List<Function<org.opensaml.saml.saml2.metadata.EntityDescriptor,Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey>>> descriptorIndexingFunctions)

Constructor.

Parameters:

descriptorIndexingFunctions - the functions used to produce index keys from an entity descriptor

Method Detail

generateKeys

@Nullable
public Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey> generateKeys(@Nonnull
                                                                                    org.opensaml.saml.saml2.metadata.EntityDescriptor descriptor)

Specified by:

generateKeys in interface org.opensaml.saml.metadata.resolver.index.MetadataIndex

generateKeys

@Nullable
public Set<org.opensaml.saml.metadata.resolver.index.MetadataIndexKey> generateKeys(@Nonnull
                                                                                    net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)

Specified by:

generateKeys in interface org.opensaml.saml.metadata.resolver.index.MetadataIndex