Interface MetadataList

All Superinterfaces:
org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.saml.common.SAMLObject, org.opensaml.core.xml.XMLObject
All Known Implementing Classes:
MetadataListImpl

public interface MetadataList extends org.opensaml.saml.common.SAMLObject, org.opensaml.core.xml.AttributeExtensibleXMLObject
Definition of the MetadataSchemeEndpointListType type.

The following schema fragment defines the MetadataSchemeEndpointListType complex type:

 
 <xs:complexType name="MetadataSchemeEndpointListType">
   <xs:annotation>
     <xs:documentation>
       Defines the metadata location(s) for a specific member state (territory).
     </xs:documentation>
   </xs:annotation>
   <xs:sequence>
     <xs:element type="ser:MetadataLocationType" name="MetadataLocation" minOccurs="0" maxOccurs="unbounded" />
   </xs:sequence>
   <xs:attribute name="Territory" type="xs:string" use="required" />
   <xs:anyAttribute namespace="##any" processContents="lax" />
 </xs:complexType>
 
Author:
Martin Lindström
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Name of the element.
    static final QName
    Default element name.
    static final String
    Attribute label for the Territory attribute.
    static final String
    Local name of the XSI type.
    static final QName
    QName of the XSI type.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns a reference to the list of metadata location elements.
    boolean
    For the Swedish eIDAS configuration, a flag, Suspend is used to indicate whether a metadata list for a specific territory is suspended.
    Returns the territory country identifier for this metadata list.
    void
    setSuspend(boolean suspendFlag)
    Assigns the Suspend flag.
    void
    setTerritory(String territory)
    Assigns the territory country identifier for this metadata list.

    Methods inherited from interface org.opensaml.core.xml.AttributeExtensibleXMLObject

    getUnknownAttributes

    Methods inherited from interface org.opensaml.core.xml.XMLObject

    detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
  • Field Details

    • DEFAULT_ELEMENT_LOCAL_NAME

      static final String DEFAULT_ELEMENT_LOCAL_NAME
      Name of the element.
      See Also:
    • DEFAULT_ELEMENT_NAME

      static final QName DEFAULT_ELEMENT_NAME
      Default element name.
    • TYPE_LOCAL_NAME

      static final String TYPE_LOCAL_NAME
      Local name of the XSI type.
      See Also:
    • TYPE_NAME

      static final QName TYPE_NAME
      QName of the XSI type.
    • TERRITORY_ATTR_NAME

      static final String TERRITORY_ATTR_NAME
      Attribute label for the Territory attribute.
      See Also:
  • Method Details

    • getMetadataLocations

      List<MetadataLocation> getMetadataLocations()
      Returns a reference to the list of metadata location elements.
      Returns:
      metadata location elements
    • getTerritory

      String getTerritory()
      Returns the territory country identifier for this metadata list.
      Returns:
      country code
    • setTerritory

      void setTerritory(String territory)
      Assigns the territory country identifier for this metadata list.
      Parameters:
      territory - country code
    • getSuspend

      boolean getSuspend()
      For the Swedish eIDAS configuration, a flag, Suspend is used to indicate whether a metadata list for a specific territory is suspended. This method is just a shortcut instead of using AttributeExtensibleXMLObject.getUnknownAttributes().
      Returns:
      if the Suspend flag has been set to true this method returns true, otherwise false 
    • setSuspend

      void setSuspend(boolean suspendFlag)
      Assigns the Suspend flag. See getSuspend().
      Parameters:
      suspendFlag - the suspend flag