org.opensaml.saml.metadata.resolver.index.MetadataIndex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-saml-api Show documentation
The newest version!
/*
 * Licensed to the University Corporation for Advanced Internet Development,
 * Inc. (UCAID) under one or more contributor license agreements.  See the
 * NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The UCAID licenses this file to You under the Apache
 * License, Version 2.0 (the "License"); you may not use this file except in
 * compliance with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.opensaml.saml.metadata.resolver.index;

import java.util.Set;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;

import org.opensaml.saml.saml2.metadata.EntityDescriptor;

/**
 * A component which defines and supports indexing an {@link EntityDescriptor}, and corresponding lookup 
 * via a {@link CriteriaSet}, using one or more (possibly implementation-specific)
 * instances of {@link MetadataIndexKey}.
 */
public interface MetadataIndex {
    
    /**
     * Generate a set of one or more {@link MetadataIndexKey} instances based on the input {@link EntityDescriptor}.
     * 
     * 
     * These index key instances reflect the type of indexing performed and "understood" by the implementation,
     * and as such should complement the {@link MetadataIndexKey} types generated for descriptor
     * lookup via {@link #generateKeys(CriteriaSet)}.
     * 
     * 
     * @param descriptor the entity descriptor set to process
     * @return the set of index keys generated from the criteria.  May be null or empty, 
     *         but will not contain null elements.
     */
    @Nullable @NonnullElements @Unmodifiable @NotLive 
    public Set generateKeys(@Nonnull final EntityDescriptor descriptor);
    
    /**
     * Generate a set of one or more {@link MetadataIndexKey} instances based on the input {@link CriteriaSet}.
     * 
     * 
     * These index key instances reflect the type of indexing performed and "understood" by the implementation,
     * and as such should complement the {@link MetadataIndexKey} types generated for descriptor
     * indexing via {@link #generateKeys(EntityDescriptor)}.
     * 
     * 
     * @param criteriaSet the criteria set to process
     * @return the set of index keys generated from the criteria.  May be null or empty, 
     *         but will not contain null elements.
     */
    @Nullable @NonnullElements @Unmodifiable @NotLive 
    public Set generateKeys(@Nonnull final CriteriaSet criteriaSet);

}