Package org.opensaml.saml.saml2.metadata

Interface RoleDescriptor

All Superinterfaces:
AttributeExtensibleXMLObject, CacheableSAMLObject, SAMLObject, SignableSAMLObject, SignableXMLObject, TimeBoundSAMLObject, XMLObject
All Known Subinterfaces:
AttributeAuthorityDescriptor, AttributeQueryDescriptorType, AuthnAuthorityDescriptor, AuthnQueryDescriptorType, AuthzDecisionQueryDescriptorType, IDPSSODescriptor, PDPDescriptor, QueryDescriptorType, SPSSODescriptor, SSODescriptor
All Known Implementing Classes:
AttributeAuthorityDescriptorImpl, AttributeQueryDescriptorTypeImpl, AuthnAuthorityDescriptorImpl, AuthnQueryDescriptorTypeImpl, AuthzDecisionQueryDescriptorTypeImpl, IDPSSODescriptorImpl, PDPDescriptorImpl, QueryDescriptorTypeImpl, RoleDescriptorImpl, RoleDescriptorXSAnyAdapter, SPSSODescriptorImpl, SSODescriptorImpl
public interface RoleDescriptor extends SignableSAMLObject, TimeBoundSAMLObject, CacheableSAMLObject, AttributeExtensibleXMLObject
SAML 2.0 Metadata RoleDescriptor.

  • Field Details

  • Method Details

    • getID

      @Nullable String getID()
      Gets the ID of this role descriptor.
      Returns:
      the ID of this role descriptor

    • setID

      void setID(@Nullable String newID)
      Sets the ID of this role descriptor.
      Parameters:
      newID - the ID of this role descriptor

    • getSupportedProtocols

      @Nonnull @NotLive @Unmodifiable List<String> getSupportedProtocols()
      Gets an immutable list of protocol URIs supported by this role.
      Returns:
      list of protocol URIs supported by this role

    • isSupportedProtocol

      boolean isSupportedProtocol(@Nonnull @NotEmpty String protocol)
      Chckes to see if the given protocol is supported by this role.
      Parameters:
      protocol - the protocol
      Returns:
      true if the protocol is supported, false if not

    • addSupportedProtocol

      void addSupportedProtocol(@Nonnull @NotEmpty String protocol)
      Adds a protocol to the list of supported protocols for this role.
      Parameters:
      protocol - the protocol

    • removeSupportedProtocol

      void removeSupportedProtocol(@Nonnull @NotEmpty String protocol)
      Removes a protocol to the list of supported protocols for this role.
      Parameters:
      protocol - the protocol

    • removeSupportedProtocols

      void removeSupportedProtocols(@Nonnull Collection<String> protocols)
      Removes a list of protocols to the list of supported protocols for this role.
      Parameters:
      protocols - the protocol

    • removeAllSupportedProtocols

      void removeAllSupportedProtocols()
      Removes all the supported protocols from this role.

    • getErrorURL

      @Nullable String getErrorURL()
      Gets the URI users should be sent to in the event of an error.
      Returns:
      the URI users should be sent to in the event of an error

    • setErrorURL

      void setErrorURL(@Nullable String errorURL)
      Sets the URI users should be sent to in the event of an error.
      Parameters:
      errorURL - the URI users should be sent to in the event of an error

    • getExtensions

      @Nullable Extensions getExtensions()
      Gets the Extensions child of this object.
      Returns:
      the Extensions child of this object

    • setExtensions

      void setExtensions(@Nullable Extensions extensions)
      Sets the Extensions child of this object.
      Parameters:
      extensions - the Extensions child of this object

    • getKeyDescriptors

      @Nonnull @Live List<KeyDescriptor> getKeyDescriptors()
      Gets the key descriptors for this role.
      Returns:
      the key descriptors for this role

    • getOrganization

      @Nullable Organization getOrganization()
      Gets the organization responsible for this role.
      Returns:
      the organization responsible for this role

    • setOrganization

      void setOrganization(@Nullable Organization organization)
      Sets the organization responsible for this role.
      Parameters:
      organization - the organization responsible for this role

    • getContactPersons

      @Nonnull @Live List<ContactPerson> getContactPersons()
      Gets list of ContactPersons for this role.
      Returns:
      list of ContactPersons for this role

    • getEndpoints

      @Nonnull @NotLive @Unmodifiable List<Endpoint> getEndpoints()
      Gets immutable list of endpoints for this role.
      Returns:
      immutable list of endpoints for this role

    • getEndpoints

      @Nonnull @NotLive @Unmodifiable List<Endpoint> getEndpoints(@Nonnull QName type)
      Gets a read-only list of endpoints for this role for the given type.
      Parameters:
      type - the type of endpoints to retrieve
      Returns:
      immutable list of endpoints for this role