Interface MetadataServiceList

All Superinterfaces:
org.opensaml.saml.common.SAMLObject, org.opensaml.saml.common.SignableSAMLObject, org.opensaml.xmlsec.signature.SignableXMLObject, org.opensaml.core.xml.XMLObject
All Known Implementing Classes:
MetadataServiceListImpl

public interface MetadataServiceList extends org.opensaml.saml.common.SignableSAMLObject
Definition of the MetadataServiceListType type.

The following schema fragment defines the MetadataServiceListType complex type:

 
 <xs:complexType name="MetadataServiceListType">
   <xs:annotation>
     <xs:documentation>
       The MetadataServiceListType is the root type for representing a metadata service list. It holds
       scheme information, metadata locations for each member state and optionally distribution point(s).
     </xs:documentation>
   </xs:annotation>
   <xs:sequence>
     <xs:element name="SchemeInformation" type="ser:SchemeInformationType" />
     <xs:element name="MetadataList" type="ser:MetadataSchemeEndpointListType" minOccurs="0" maxOccurs="unbounded" />
     <xs:element name="DistributionPoints" type="ser:DistributionPointsType" />
     <xs:element ref="ds:Signature" minOccurs="0" />
   </xs:sequence>
   <xs:attribute name="Version" type="xs:string" use="required">
     <xs:annotation>
       <xs:documentation>
         The version of a metadata service list.
       </xs:documentation>
     </xs:annotation>
   </xs:attribute>
   <xs:attribute name="IssueDate" type="xs:dateTime" use="required">
     <xs:annotation>
       <xs:documentation>
         Issuance time for a metadata service list.
       </xs:documentation>
     </xs:annotation>
   </xs:attribute>
   <xs:attribute name="NextUpdate" type="xs:dateTime">
     <xs:annotation>
       <xs:documentation>
         Time when the next metadata service list will be published.
       </xs:documentation>
     </xs:annotation>
   </xs:attribute>
   <xs:attribute name="ID" type="xs:ID">
     <xs:annotation>
       <xs:documentation>
         The unique ID for a metadata service list.
       </xs:documentation>
     </xs:annotation>
   </xs:attribute>
 </xs:complexType>
 
Author:
Martin Lindström
  • 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.
    • ISSUE_DATE_ATTR_NAME

      static final String ISSUE_DATE_ATTR_NAME
      Attribute label for the IssueDate attribute.
      See Also:
    • ISSUE_DATE_ATTR_QNAME

      static final QName ISSUE_DATE_ATTR_QNAME
      QName for the attribute which defines the IssueDate attribute.
    • NEXT_UPDATE_ATTR_NAME

      static final String NEXT_UPDATE_ATTR_NAME
      Attribute label for the NextUpdate attribute.
      See Also:
    • NEXT_UPDATE_ATTR_QNAME

      static final QName NEXT_UPDATE_ATTR_QNAME
      QName for the attribute which defines the NextUpdate attribute.
    • ID_ATTR_NAME

      static final String ID_ATTR_NAME
      Attribute label for the ID attribute.
      See Also:
    • VERSION_ATTR_NAME

      static final String VERSION_ATTR_NAME
      Attribute label for the Version attribute.
      See Also:
  • Method Details

    • getVersion

      Returns the version for this metadata service list.
      Returns:
      the version
    • setVersion

      void setVersion(MetadataServiceListVersion version)
      Assigns the version for this metadata service list.
      Parameters:
      version - the version
    • getID

      String getID()
      Sets the ID of this list.
      Returns:
      the ID
    • setID

      void setID(String id)
      Assigns the ID of this list.
      Parameters:
      id - the ID
    • getIssueDate

      Instant getIssueDate()
      Returns the issue date attribute value.
      Returns:
      the issue date
    • setIssueDate

      void setIssueDate(Instant issueDate)
      Assigns the issue date attribute value.
      Parameters:
      issueDate - the issue date
    • getNextUpdate

      Instant getNextUpdate()
      Returns the next-update attribute value.
      Returns:
      the next update
    • setNextUpdate

      void setNextUpdate(Instant nextUpdate)
      Assigns the next-update attribute value.
      Parameters:
      nextUpdate - the next update
    • getSchemeInformation

      SchemeInformation getSchemeInformation()
      Returns the scheme information element for this list.
      Returns:
      scheme information
    • setSchemeInformation

      void setSchemeInformation(SchemeInformation schemeInformation)
      Assigns the scheme information element for this list.
      Parameters:
      schemeInformation - scheme information
    • getMetadataLists

      List<MetadataList> getMetadataLists()
      Returns a reference to the list of metadata lists held.
      Returns:
      a list of metadata lists
    • getDistributionPoints

      DistributionPoints getDistributionPoints()
      Returns the distribution points element.
      Returns:
      the distribution points element
    • setDistributionPoints

      void setDistributionPoints(DistributionPoints distributionPoints)
      Assigns the distribution points element.
      Parameters:
      distributionPoints - distribution points