/*
 * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
 * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
 * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
 * compliance with the Licence. You may obtain a copy of the Licence at:
 * https://joinup.ec.europa.eu/news/understanding-eupl-v12
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the Licence
 * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the Licence for the specific language governing permissions and limitations under
 * the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text file for details on the
 * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
 * works that you distribute must include a readable copy of the "NOTICE" text file.
*/

package at.gv.egiz.eaaf.modules.pvp2.api.metadata;

import java.util.List;

import javax.xml.namespace.QName;

import org.opensaml.saml2.metadata.EntitiesDescriptor;
import org.opensaml.saml2.metadata.EntityDescriptor;
import org.opensaml.saml2.metadata.RoleDescriptor;
import org.opensaml.saml2.metadata.provider.MetadataFilter;
import org.opensaml.saml2.metadata.provider.MetadataProvider;
import org.opensaml.saml2.metadata.provider.MetadataProviderException;
import org.opensaml.xml.XMLObject;

public interface IPvpMetadataProvider extends MetadataProvider {

  @Override
  boolean requireValidMetadata();

  @Override
  void setRequireValidMetadata(boolean requireValidMetadata);

  @Override
  MetadataFilter getMetadataFilter();

  @Override
  void setMetadataFilter(MetadataFilter newFilter) throws MetadataProviderException;

  @Override
  XMLObject getMetadata() throws MetadataProviderException;

  @Override
  EntitiesDescriptor getEntitiesDescriptor(String entitiesID) throws MetadataProviderException;

  @Override
  EntityDescriptor getEntityDescriptor(String entityID) throws MetadataProviderException;

  @Override
  List<RoleDescriptor> getRole(String entityID, QName roleName) throws MetadataProviderException;

  @Override
  RoleDescriptor getRole(String entityID, QName roleName, String supportedProtocol)
      throws MetadataProviderException;

}