se.swedenconnect.opensaml.saml2.metadata.PeerMetadataResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensaml-addons Show documentation

OpenSAML 5.X utility extension library

The newest version!

/*
 * Copyright 2016-2024 Sweden Connect
 *
 * Licensed 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 se.swedenconnect.opensaml.saml2.metadata;

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

/**
 * Simple functional interface for obtaining the peer metadata.
 *
 * @author Martin Lindström ([email protected])
 */
@FunctionalInterface
public interface PeerMetadataResolver {

  /**
   * Returns the metadata {@code EntityDescriptor} for the given entityID.
   *
   * @param entityID the IdP entityID
   * @return an EntityDescriptor object, or null if no metadata record can be found
   */
  EntityDescriptor getMetadata(final String entityID);
}