Class EntityDescriptorImpl

All Implemented Interfaces:
AttributeExtensibleXMLObject, XMLObject, SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, EntityDescriptor, SignableXMLObject

public class EntityDescriptorImpl
extends AbstractSignableSAMLObject
implements EntityDescriptor
Concretate implementation of EntitiesDescriptor.
  • Field Details

  • Constructor Details

    • 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 Details

    • getEntityID

      public String getEntityID()
      Gets the entity ID for this entity descriptor.
      Specified by:
      getEntityID in interface EntityDescriptor
      Returns:
      the entity ID for this entity descriptor
    • setEntityID

      public void setEntityID​(String newId)
      Sets the entity ID for this entity descriptor.
      Specified by:
      setEntityID in interface EntityDescriptor
      Parameters:
      newId - the entity ID for this entity descriptor
    • getID

      public String getID()
      Gets the ID for this entity descriptor.
      Specified by:
      getID in interface EntityDescriptor
      Returns:
      the ID for this entity descriptor
    • setID

      public void setID​(String newID)
      Sets the ID for this entity descriptor.
      Specified by:
      setID in interface EntityDescriptor
      Parameters:
      newID - the ID for this entity descriptor
    • isValid

      public boolean isValid()
      Checks to see if the current time is past the validUntil time.
      Specified by:
      isValid in interface TimeBoundSAMLObject
      Returns:
      true of this descriptor is still valid otherwise false
    • getValidUntil

      public Instant getValidUntil()
      Gets the date until which this descriptor is valid.
      Specified by:
      getValidUntil in interface TimeBoundSAMLObject
      Returns:
      the date until which this descriptor is valid
    • setValidUntil

      public void setValidUntil​(Instant newValidUntil)
      Sets the date until which this descriptor is valid.
      Specified by:
      setValidUntil in interface TimeBoundSAMLObject
      Parameters:
      newValidUntil - the date until which this descriptor is valid
    • getCacheDuration

      public Duration getCacheDuration()
      Gets the maximum time that this descriptor should be cached.
      Specified by:
      getCacheDuration in interface CacheableSAMLObject
      Returns:
      the maximum time that this descriptor should be cached
    • setCacheDuration

      public void setCacheDuration​(Duration duration)
      Sets the maximum time that this descriptor should be cached.
      Specified by:
      setCacheDuration in interface CacheableSAMLObject
      Parameters:
      duration - the maximum time that this descriptor should be cached
    • getExtensions

      public Extensions getExtensions()
      Gets the Extensions child of this object.
      Specified by:
      getExtensions in interface EntityDescriptor
      Returns:
      the Extensions child of this object
    • setExtensions

      public void setExtensions​(Extensions newExtensions)
      Sets the Extensions child of this object.
      Specified by:
      setExtensions in interface EntityDescriptor
      Parameters:
      newExtensions - the Extensions child of this object
    • getRoleDescriptors

      public List<RoleDescriptor> getRoleDescriptors()
      Gets all the role descriptors for this entity descriptor.
      Specified by:
      getRoleDescriptors in interface EntityDescriptor
      Returns:
      the role descriptors for this entity descriptor
    • getRoleDescriptors

      public List<RoleDescriptor> getRoleDescriptors​(QName typeOrName)
      Gets all the role descriptors for this entity descriptor that match the supplied QName parameter.
      Specified by:
      getRoleDescriptors in interface EntityDescriptor
      Parameters:
      typeOrName - the name of the role
      Returns:
      the role descriptors for this entity descriptor
    • getRoleDescriptors

      public List<RoleDescriptor> getRoleDescriptors​(QName type, String supportedProtocol)
      Gets all the role descriptors for this entity that support the given protocol.
      Specified by:
      getRoleDescriptors in interface EntityDescriptor
      Parameters:
      type - the name of the role
      supportedProtocol - the supported protocol
      Returns:
      the list of role descriptors that support the given protocol
    • getIDPSSODescriptor

      public IDPSSODescriptor getIDPSSODescriptor​(String supportedProtocol)
      Gets the first IDPSSODescriptor role descriptor for this entity that supports the given protocol.
      Specified by:
      getIDPSSODescriptor in interface EntityDescriptor
      Parameters:
      supportedProtocol - protocol that must be supported
      Returns:
      the IDPSSODescriptor role descriptor
    • getSPSSODescriptor

      public SPSSODescriptor getSPSSODescriptor​(String supportedProtocol)
      Gets the first SPSSODescriptor role descriptor for this entity that supports the given protocol.
      Specified by:
      getSPSSODescriptor in interface EntityDescriptor
      Parameters:
      supportedProtocol - protocol that must be supported
      Returns:
      the SPSSODescriptor role descriptor
    • getAuthnAuthorityDescriptor

      public AuthnAuthorityDescriptor getAuthnAuthorityDescriptor​(String supportedProtocol)
      Gets the first AuthnAuthorityDescriptor role descriptor for this entity that supports the given protocol.
      Specified by:
      getAuthnAuthorityDescriptor in interface EntityDescriptor
      Parameters:
      supportedProtocol - protocol that must be supported
      Returns:
      the AuthnAuthorityDescriptor role descriptor
    • getAttributeAuthorityDescriptor

      public AttributeAuthorityDescriptor getAttributeAuthorityDescriptor​(String supportedProtocol)
      Gets the first AttributeAuthorityDescriptor role descriptor for this entity that supports the given protocol.
      Specified by:
      getAttributeAuthorityDescriptor in interface EntityDescriptor
      Parameters:
      supportedProtocol - protocol that must be supported
      Returns:
      the AttributeAuthorityDescriptor role descriptor
    • getPDPDescriptor

      public PDPDescriptor getPDPDescriptor​(String supportedProtocol)
      Gets the first PDPDescriptor role descriptor for this entity that supports the given protocol.
      Specified by:
      getPDPDescriptor in interface EntityDescriptor
      Parameters:
      supportedProtocol - protocol that must be supported
      Returns:
      the PDPDescriptor role descriptor
    • getAffiliationDescriptor

      public AffiliationDescriptor getAffiliationDescriptor()
      Gets the affiliation descriptor for this entity.
      Specified by:
      getAffiliationDescriptor in interface EntityDescriptor
      Returns:
      the affiliation descriptor for this entity
    • setAffiliationDescriptor

      public void setAffiliationDescriptor​(AffiliationDescriptor descriptor)
      Sets the affiliation descriptor for this entity.
      Specified by:
      setAffiliationDescriptor in interface EntityDescriptor
      Parameters:
      descriptor - the affiliation descriptor for this entity
    • getOrganization

      public Organization getOrganization()
      Gets the organization for this entity.
      Specified by:
      getOrganization in interface EntityDescriptor
      Returns:
      the organization for this entity
    • setOrganization

      public void setOrganization​(Organization newOrganization)
      Sets the organization for this entity.
      Specified by:
      setOrganization in interface EntityDescriptor
      Parameters:
      newOrganization - the organization for this entity
    • getContactPersons

      public List<ContactPerson> getContactPersons()
      Get the contact people for this entity.
      Specified by:
      getContactPersons in interface EntityDescriptor
      Returns:
      the contact people for this entity
    • getAdditionalMetadataLocations

      public List<AdditionalMetadataLocation> getAdditionalMetadataLocations()
      Gets the additional metadata locations for this entity.
      Specified by:
      getAdditionalMetadataLocations in interface EntityDescriptor
      Returns:
      the additional metadata locations for this entity
    • getUnknownAttributes

      public AttributeMap getUnknownAttributes()
      Gets a mutable map of the attributes. The map key is the namespace qualified name of the attribute, the map value is the value of the attribute.
      Specified by:
      getUnknownAttributes in interface AttributeExtensibleXMLObject
      Returns:
      a map of the attributes
    • getSignatureReferenceID

      public String getSignatureReferenceID()
      Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
      Specified by:
      getSignatureReferenceID in interface SignableSAMLObject
      Returns:
      the value of this SAMLObject ID attribute
    • getOrderedChildren

      public List<XMLObject> getOrderedChildren()
      Gets an unmodifiable list of child elements in the order that they will appear in the DOM.
      Specified by:
      getOrderedChildren in interface XMLObject
      Returns:
      ordered list of child elements