Class EntityDescriptorImpl

  • All Implemented Interfaces:
    org.opensaml.core.xml.AttributeExtensibleXMLObject, org.opensaml.core.xml.XMLObject, org.opensaml.saml.common.SAMLObject, org.opensaml.saml.common.SignableSAMLObject, org.opensaml.saml.saml2.common.CacheableSAMLObject, org.opensaml.saml.saml2.common.TimeBoundSAMLObject, org.opensaml.saml.saml2.metadata.EntityDescriptor, org.opensaml.xmlsec.signature.SignableXMLObject

    public class EntityDescriptorImpl
    extends org.opensaml.saml.common.AbstractSignableSAMLObject
    implements org.opensaml.saml.saml2.metadata.EntityDescriptor
    Concretate implementation of EntitiesDescriptor.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.AdditionalMetadataLocation> additionalMetadata
      Additional metadata locations for this entity.
      private org.opensaml.saml.saml2.metadata.AffiliationDescriptor affiliationDescriptor
      Affiliatition descriptor for this entity.
      private Duration cacheDuration
      cacheDurection attribute.
      private org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.ContactPerson> contactPersons
      Contact persons for this entity.
      private String entityID
      Entity ID of this Entity.
      private org.opensaml.saml.saml2.metadata.Extensions extensions
      Extensions child.
      private String id
      ID attribute.
      private org.opensaml.saml.saml2.metadata.Organization organization
      Organization the administers this entity.
      private org.opensaml.core.xml.util.IndexedXMLObjectChildrenList<org.opensaml.saml.saml2.metadata.RoleDescriptor> roleDescriptors
      Role descriptors for this entity.
      private org.opensaml.core.xml.util.AttributeMap unknownAttributes
      "anyAttribute" attributes.
      private Instant validUntil
      validUntil attribute.
      • Fields inherited from interface org.opensaml.saml.saml2.common.CacheableSAMLObject

        CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME
      • Fields inherited from interface org.opensaml.saml.saml2.metadata.EntityDescriptor

        DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ELEMENT_QNAME, ENTITY_ID_ATTRIB_NAME, ID_ATTRIB_NAME, TYPE_LOCAL_NAME, TYPE_NAME
      • Fields inherited from interface org.opensaml.saml.saml2.common.TimeBoundSAMLObject

        VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      List<org.opensaml.saml.saml2.metadata.AdditionalMetadataLocation> getAdditionalMetadataLocations()
      org.opensaml.saml.saml2.metadata.AffiliationDescriptor getAffiliationDescriptor()
      org.opensaml.saml.saml2.metadata.AttributeAuthorityDescriptor getAttributeAuthorityDescriptor​(String supportedProtocol)
      org.opensaml.saml.saml2.metadata.AuthnAuthorityDescriptor getAuthnAuthorityDescriptor​(String supportedProtocol)
      Duration getCacheDuration()
      List<org.opensaml.saml.saml2.metadata.ContactPerson> getContactPersons()
      String getEntityID()
      org.opensaml.saml.saml2.metadata.Extensions getExtensions()
      String getID()
      org.opensaml.saml.saml2.metadata.IDPSSODescriptor getIDPSSODescriptor​(String supportedProtocol)
      List<org.opensaml.core.xml.XMLObject> getOrderedChildren()
      org.opensaml.saml.saml2.metadata.Organization getOrganization()
      org.opensaml.saml.saml2.metadata.PDPDescriptor getPDPDescriptor​(String supportedProtocol)
      List<org.opensaml.saml.saml2.metadata.RoleDescriptor> getRoleDescriptors()
      List<org.opensaml.saml.saml2.metadata.RoleDescriptor> getRoleDescriptors​(QName typeOrName)
      List<org.opensaml.saml.saml2.metadata.RoleDescriptor> getRoleDescriptors​(QName type, String supportedProtocol)
      String getSignatureReferenceID()
      org.opensaml.saml.saml2.metadata.SPSSODescriptor getSPSSODescriptor​(String supportedProtocol)
      org.opensaml.core.xml.util.AttributeMap getUnknownAttributes()
      Instant getValidUntil()
      boolean isValid()
      void setAffiliationDescriptor​(org.opensaml.saml.saml2.metadata.AffiliationDescriptor descriptor)
      void setCacheDuration​(Duration duration)
      void setEntityID​(String newId)
      void setExtensions​(org.opensaml.saml.saml2.metadata.Extensions newExtensions)
      void setID​(String newID)
      void setOrganization​(org.opensaml.saml.saml2.metadata.Organization newOrganization)
      void setValidUntil​(Instant newValidUntil)
      • Methods inherited from class org.opensaml.saml.common.AbstractSignableSAMLObject

        equals, hashCode, setSignature
      • Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject

        getSignature, isSigned
      • Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

        detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType
      • Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject

        getSignature, isSigned, setSignature
      • Methods inherited from interface org.opensaml.core.xml.XMLObject

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

      • entityID

        private String entityID
        Entity ID of this Entity.
      • id

        private String id
        ID attribute.
      • validUntil

        private Instant validUntil
        validUntil attribute.
      • cacheDuration

        private Duration cacheDuration
        cacheDurection attribute.
      • extensions

        private org.opensaml.saml.saml2.metadata.Extensions extensions
        Extensions child.
      • roleDescriptors

        private final org.opensaml.core.xml.util.IndexedXMLObjectChildrenList<org.opensaml.saml.saml2.metadata.RoleDescriptor> roleDescriptors
        Role descriptors for this entity.
      • affiliationDescriptor

        private org.opensaml.saml.saml2.metadata.AffiliationDescriptor affiliationDescriptor
        Affiliatition descriptor for this entity.
      • organization

        private org.opensaml.saml.saml2.metadata.Organization organization
        Organization the administers this entity.
      • contactPersons

        private final org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.ContactPerson> contactPersons
        Contact persons for this entity.
      • additionalMetadata

        private final org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.AdditionalMetadataLocation> additionalMetadata
        Additional metadata locations for this entity.
      • unknownAttributes

        private final org.opensaml.core.xml.util.AttributeMap unknownAttributes
        "anyAttribute" attributes.
    • Constructor Detail

      • EntityDescriptorImpl

        protected EntityDescriptorImpl​(String namespaceURI,
                                       String elementLocalName,
                                       String namespacePrefix)
        Constructor.
        Parameters:
        namespaceURI - the namespace the element is in
        elementLocalName - the local name of the XML element this Object represents
        namespacePrefix - the prefix for the given namespace
    • Method Detail

      • getEntityID

        public String getEntityID()
        Specified by:
        getEntityID in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • setEntityID

        public void setEntityID​(String newId)
        Specified by:
        setEntityID in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getID

        public String getID()
        Specified by:
        getID in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • setID

        public void setID​(String newID)
        Specified by:
        setID in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • isValid

        public boolean isValid()
        Specified by:
        isValid in interface org.opensaml.saml.saml2.common.TimeBoundSAMLObject
      • getValidUntil

        public Instant getValidUntil()
        Specified by:
        getValidUntil in interface org.opensaml.saml.saml2.common.TimeBoundSAMLObject
      • setValidUntil

        public void setValidUntil​(Instant newValidUntil)
        Specified by:
        setValidUntil in interface org.opensaml.saml.saml2.common.TimeBoundSAMLObject
      • getCacheDuration

        public Duration getCacheDuration()
        Specified by:
        getCacheDuration in interface org.opensaml.saml.saml2.common.CacheableSAMLObject
      • setCacheDuration

        public void setCacheDuration​(Duration duration)
        Specified by:
        setCacheDuration in interface org.opensaml.saml.saml2.common.CacheableSAMLObject
      • getExtensions

        public org.opensaml.saml.saml2.metadata.Extensions getExtensions()
        Specified by:
        getExtensions in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • setExtensions

        public void setExtensions​(org.opensaml.saml.saml2.metadata.Extensions newExtensions)
        Specified by:
        setExtensions in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getRoleDescriptors

        public List<org.opensaml.saml.saml2.metadata.RoleDescriptor> getRoleDescriptors()
        Specified by:
        getRoleDescriptors in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getRoleDescriptors

        public List<org.opensaml.saml.saml2.metadata.RoleDescriptor> getRoleDescriptors​(QName typeOrName)
        Specified by:
        getRoleDescriptors in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getRoleDescriptors

        public List<org.opensaml.saml.saml2.metadata.RoleDescriptor> getRoleDescriptors​(QName type,
                                                                                        String supportedProtocol)
        Specified by:
        getRoleDescriptors in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getIDPSSODescriptor

        public org.opensaml.saml.saml2.metadata.IDPSSODescriptor getIDPSSODescriptor​(String supportedProtocol)
        Specified by:
        getIDPSSODescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getSPSSODescriptor

        public org.opensaml.saml.saml2.metadata.SPSSODescriptor getSPSSODescriptor​(String supportedProtocol)
        Specified by:
        getSPSSODescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getAuthnAuthorityDescriptor

        public org.opensaml.saml.saml2.metadata.AuthnAuthorityDescriptor getAuthnAuthorityDescriptor​(String supportedProtocol)
        Specified by:
        getAuthnAuthorityDescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getAttributeAuthorityDescriptor

        public org.opensaml.saml.saml2.metadata.AttributeAuthorityDescriptor getAttributeAuthorityDescriptor​(String supportedProtocol)
        Specified by:
        getAttributeAuthorityDescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getPDPDescriptor

        public org.opensaml.saml.saml2.metadata.PDPDescriptor getPDPDescriptor​(String supportedProtocol)
        Specified by:
        getPDPDescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getAffiliationDescriptor

        public org.opensaml.saml.saml2.metadata.AffiliationDescriptor getAffiliationDescriptor()
        Specified by:
        getAffiliationDescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • setAffiliationDescriptor

        public void setAffiliationDescriptor​(org.opensaml.saml.saml2.metadata.AffiliationDescriptor descriptor)
        Specified by:
        setAffiliationDescriptor in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getOrganization

        public org.opensaml.saml.saml2.metadata.Organization getOrganization()
        Specified by:
        getOrganization in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • setOrganization

        public void setOrganization​(org.opensaml.saml.saml2.metadata.Organization newOrganization)
        Specified by:
        setOrganization in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getContactPersons

        public List<org.opensaml.saml.saml2.metadata.ContactPerson> getContactPersons()
        Specified by:
        getContactPersons in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getAdditionalMetadataLocations

        public List<org.opensaml.saml.saml2.metadata.AdditionalMetadataLocation> getAdditionalMetadataLocations()
        Specified by:
        getAdditionalMetadataLocations in interface org.opensaml.saml.saml2.metadata.EntityDescriptor
      • getUnknownAttributes

        public org.opensaml.core.xml.util.AttributeMap getUnknownAttributes()
        Specified by:
        getUnknownAttributes in interface org.opensaml.core.xml.AttributeExtensibleXMLObject
      • getSignatureReferenceID

        public String getSignatureReferenceID()
        Specified by:
        getSignatureReferenceID in interface org.opensaml.saml.common.SignableSAMLObject
      • getOrderedChildren

        public List<org.opensaml.core.xml.XMLObject> getOrderedChildren()
        Specified by:
        getOrderedChildren in interface org.opensaml.core.xml.XMLObject