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

Class RoleDescriptorImpl

  • 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.RoleDescriptor, org.opensaml.xmlsec.signature.SignableXMLObject
    Direct Known Subclasses:
    AttributeAuthorityDescriptorImpl, AuthnAuthorityDescriptorImpl, PDPDescriptorImpl, QueryDescriptorTypeImpl, SSODescriptorImpl
    public abstract class RoleDescriptorImpl
extends org.opensaml.saml.common.AbstractSignableSAMLObject
implements org.opensaml.saml.saml2.metadata.RoleDescriptor
    Concrete implementation of RoleDescriptor.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Duration cacheDuration
      cacheDurection attribute.
      private org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.ContactPerson> contactPersons
      Contact persons for this role.
      private String errorURL
      Error URL.
      private org.opensaml.saml.saml2.metadata.Extensions extensions
      Extensions child.
      private String id
      ID attribute.
      private org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.KeyDescriptor> keyDescriptors
      Key descriptors for this role.
      private org.opensaml.saml.saml2.metadata.Organization organization
      Organization administering this role.
      private List<String> supportedProtocols
      Set of supported protocols.
      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.RoleDescriptor

        DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ERROR_URL_ATTRIB_NAME, ID_ATTRIB_NAME, PROTOCOL_ENUMERATION_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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected RoleDescriptorImpl​(String namespaceURI, String elementLocalName, String namespacePrefix)
      Constructor.

    • Field Detail

      • id

        private String id
        ID attribute.

      • validUntil

        private Instant validUntil
        validUntil attribute.

      • cacheDuration

        private Duration cacheDuration
        cacheDurection attribute.

      • supportedProtocols

        private final List<String> supportedProtocols
        Set of supported protocols.

      • errorURL

        private String errorURL
        Error URL.

      • extensions

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

      • organization

        private org.opensaml.saml.saml2.metadata.Organization organization
        Organization administering this role.

      • unknownAttributes

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

      • contactPersons

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

      • keyDescriptors

        private final org.opensaml.core.xml.util.XMLObjectChildrenList<org.opensaml.saml.saml2.metadata.KeyDescriptor> keyDescriptors
        Key descriptors for this role.

    • Constructor Detail

      • RoleDescriptorImpl

        protected RoleDescriptorImpl​(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

      • getID

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

      • setID

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

      • 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 dt)
        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

      • getSupportedProtocols

        public List<String> getSupportedProtocols()
        Specified by:
        getSupportedProtocols in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • isSupportedProtocol

        public boolean isSupportedProtocol​(String protocol)
        Specified by:
        isSupportedProtocol in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • addSupportedProtocol

        public void addSupportedProtocol​(String protocol)
        Specified by:
        addSupportedProtocol in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • removeSupportedProtocol

        public void removeSupportedProtocol​(String protocol)
        Specified by:
        removeSupportedProtocol in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • removeSupportedProtocols

        public void removeSupportedProtocols​(Collection<String> protocols)
        Specified by:
        removeSupportedProtocols in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • removeAllSupportedProtocols

        public void removeAllSupportedProtocols()
        Specified by:
        removeAllSupportedProtocols in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • getErrorURL

        public String getErrorURL()
        Specified by:
        getErrorURL in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • setErrorURL

        public void setErrorURL​(String url)
        Specified by:
        setErrorURL in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • getExtensions

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

      • setExtensions

        public void setExtensions​(org.opensaml.saml.saml2.metadata.Extensions ext)
        Specified by:
        setExtensions in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • getOrganization

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

      • setOrganization

        public void setOrganization​(org.opensaml.saml.saml2.metadata.Organization org)
        Specified by:
        setOrganization in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • getContactPersons

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

      • getKeyDescriptors

        public List<org.opensaml.saml.saml2.metadata.KeyDescriptor> getKeyDescriptors()
        Specified by:
        getKeyDescriptors in interface org.opensaml.saml.saml2.metadata.RoleDescriptor

      • 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