se.swedenconnect.opensaml.eidas.metadata.MetadataList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-eidas Show documentation
OpenSAML 5.X extension library for the eIDAS Framework
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.eidas.metadata;

import org.opensaml.core.xml.AttributeExtensibleXMLObject;
import org.opensaml.saml.common.SAMLObject;
import se.swedenconnect.opensaml.eidas.common.EidasConstants;

import javax.xml.namespace.QName;
import java.util.List;

/**
 * Definition of the {@code MetadataSchemeEndpointListType} type.
 * 
 * The following schema fragment defines the MetadataSchemeEndpointListType complex type:
 * 
 *  * {@code
 * 
 *   
 *     
 *       Defines the metadata location(s) for a specific member state (territory).
 *     
 *   
 *   
 *     
 *   
 *   
 *   
 * }
 * 
 *
 * @author Martin Lindström
 */
public interface MetadataList extends SAMLObject, AttributeExtensibleXMLObject {

  /** Name of the element. */
  String DEFAULT_ELEMENT_LOCAL_NAME = "MetadataList";

  /** Default element name. */
  QName DEFAULT_ELEMENT_NAME = new QName(EidasConstants.EIDAS_SERVICELIST_NS, DEFAULT_ELEMENT_LOCAL_NAME,
      EidasConstants.EIDAS_SERVICELIST_PREFIX);

  /** Local name of the XSI type. */
  String TYPE_LOCAL_NAME = "MetadataSchemeEndpointListType";

  /** QName of the XSI type. */
  QName TYPE_NAME =
      new QName(EidasConstants.EIDAS_SERVICELIST_NS, TYPE_LOCAL_NAME, EidasConstants.EIDAS_SERVICELIST_PREFIX);

  /** Attribute label for the Territory attribute. */
  String TERRITORY_ATTR_NAME = "Territory";

  /**
   * Returns a reference to the list of metadata location elements.
   *
   * @return metadata location elements
   */
  List getMetadataLocations();

  /**
   * Returns the territory country identifier for this metadata list.
   *
   * @return country code
   */
  String getTerritory();

  /**
   * Assigns the territory country identifier for this metadata list.
   *
   * @param territory country code
   */
  void setTerritory(final String territory);

  /**
   * For the Swedish eIDAS configuration, a flag, {@code Suspend} is used to indicate whether a metadata list for a
   * specific territory is suspended. This method is just a shortcut instead of using {@link #getUnknownAttributes()}.
   *
   * @return if the {@code Suspend} flag has been set to {@code true} this method returns {@code true}, otherwise
   *     {@code false} 
   */
  boolean getSuspend();

  /**
   * Assigns the {@code Suspend} flag. See {@link #getSuspend()}.
   *
   * @param suspendFlag the suspend flag
   */
  void setSuspend(final boolean suspendFlag);

}