Package org.opensaml.saml.saml2.metadata.impl

Class EntitiesDescriptorImpl

java.lang.Object
org.opensaml.core.xml.AbstractXMLObject
org.opensaml.xmlsec.signature.AbstractSignableXMLObject
org.opensaml.saml.common.AbstractSignableSAMLObject
org.opensaml.saml.saml2.metadata.impl.EntitiesDescriptorImpl
All Implemented Interfaces:
XMLObject, SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, EntitiesDescriptor, SignableXMLObject
public class EntitiesDescriptorImpl extends AbstractSignableSAMLObject implements EntitiesDescriptor
Concrete implementation of EntitiesDescriptor.

  • Field Details

    • name

      @Nullable private String name
      Name of this descriptor group.

    • id

      @Nullable private String id
      ID attribute.

    • validUntil

      @Nullable private Instant validUntil
      validUntil attribute.

    • cacheDuration

      @Nullable private Duration cacheDuration
      cacheDurection attribute.

    • extensions

      @Nullable private Extensions extensions
      Extensions child.

    • orderedDescriptors

      @Nonnull private final IndexedXMLObjectChildrenList<SAMLObject> orderedDescriptors
      Ordered set of child Entity/Entities Descriptors.

  • Constructor Details

    • EntitiesDescriptorImpl

      protected EntitiesDescriptorImpl(@Nullable String namespaceURI, @Nonnull String elementLocalName, @Nullable 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

    • getName

      @Nullable public String getName()
      Gets the name of this entity group.
      Specified by:
      getName in interface EntitiesDescriptor
      Returns:
      the name of this entity group

    • setName

      public void setName(@Nullable String newName)
      Sets the name of this entity group.
      Specified by:
      setName in interface EntitiesDescriptor
      Parameters:
      newName - the name of this entity group

    • getID

      @Nullable public String getID()
      Gets the ID of this entity group.
      Specified by:
      getID in interface EntitiesDescriptor
      Returns:
      the id of this entity group

    • setID

      public void setID(@Nullable String newID)
      Sets the ID of this entity group.
      Specified by:
      setID in interface EntitiesDescriptor
      Parameters:
      newID - the ID of this entity group

    • 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

      @Nullable 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(@Nullable 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

      @Nullable 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(@Nullable 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

      @Nullable public Extensions getExtensions()
      Gets the Extensions child of this object.
      Specified by:
      getExtensions in interface EntitiesDescriptor
      Returns:
      the Extensions child of this object

    • setExtensions

      public void setExtensions(@Nullable Extensions newExtensions)
      Sets the Extensions child of this object.
      Specified by:
      setExtensions in interface EntitiesDescriptor
      Parameters:
      newExtensions - the Extensions child of this object

    • getEntitiesDescriptors

      @Nonnull @Live public List<EntitiesDescriptor> getEntitiesDescriptors()
      Gets a list of child EntitiesDescriptors.
      Specified by:
      getEntitiesDescriptors in interface EntitiesDescriptor
      Returns:
      list of descriptors

    • getEntityDescriptors

      @Nonnull @Live public List<EntityDescriptor> getEntityDescriptors()
      Gets a list of child EntityDescriptors.
      Specified by:
      getEntityDescriptors in interface EntitiesDescriptor
      Returns:
      list of child descriptors

    • 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

      @Nullable @NotLive @Unmodifiable 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