Interface MetadataIndex
-
public interface MetadataIndex
A component which defines and supports indexing anEntityDescriptor
, and corresponding lookup via aCriteriaSet
, using one or more (possibly implementation-specific) instances ofMetadataIndexKey
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Set<MetadataIndexKey>
generateKeys(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
Generate a set of one or moreMetadataIndexKey
instances based on the inputCriteriaSet
.Set<MetadataIndexKey>
generateKeys(EntityDescriptor descriptor)
Generate a set of one or moreMetadataIndexKey
instances based on the inputEntityDescriptor
.
-
-
-
Method Detail
-
generateKeys
@Nullable @NonnullElements @Unmodifiable @NotLive Set<MetadataIndexKey> generateKeys(@Nonnull EntityDescriptor descriptor)
Generate a set of one or moreMetadataIndexKey
instances based on the inputEntityDescriptor
.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 viagenerateKeys(CriteriaSet)
.- 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.
-
generateKeys
@Nullable @NonnullElements @Unmodifiable @NotLive Set<MetadataIndexKey> generateKeys(@Nonnull net.shibboleth.utilities.java.support.resolver.CriteriaSet criteriaSet)
Generate a set of one or moreMetadataIndexKey
instances based on the inputCriteriaSet
.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 viagenerateKeys(EntityDescriptor)
.- 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.
-
-