Package org.opensaml.saml.saml2.metadata

Interface SPSSODescriptor

All Superinterfaces:
AttributeExtensibleXMLObject, CacheableSAMLObject, RoleDescriptor, SAMLObject, SignableSAMLObject, SignableXMLObject, SSODescriptor, TimeBoundSAMLObject, XMLObject
All Known Implementing Classes:
SPSSODescriptorImpl
public interface SPSSODescriptor extends SSODescriptor
SAML 2.0 Metadata SPSSODescriptorType.

  • Field Details

    • DEFAULT_ELEMENT_LOCAL_NAME

      @Nonnull @NotEmpty static final String DEFAULT_ELEMENT_LOCAL_NAME
      Element name, no namespace.
      See Also:

    • DEFAULT_ELEMENT_NAME

      @Nonnull static final QName DEFAULT_ELEMENT_NAME
      Default element name.

    • TYPE_LOCAL_NAME

      @Nonnull @NotEmpty static final String TYPE_LOCAL_NAME
      Local name of the XSI type.
      See Also:

    • TYPE_NAME

      @Nonnull static final QName TYPE_NAME
      QName of the XSI type.

    • AUTH_REQUESTS_SIGNED_ATTRIB_NAME

      @Nonnull @NotEmpty static final String AUTH_REQUESTS_SIGNED_ATTRIB_NAME
      "AuthnRequestsSigned" attribute's local name.
      See Also:

    • WANT_ASSERTIONS_SIGNED_ATTRIB_NAME

      @Nonnull @NotEmpty static final String WANT_ASSERTIONS_SIGNED_ATTRIB_NAME
      "WantAssertionsSigned" attribute's local name.
      See Also:

  • Method Details

    • isAuthnRequestsSigned

      @Nullable Boolean isAuthnRequestsSigned()
      Gets whether this service signs AuthN requests.
      Returns:
      true of this service signs requests, false if not

    • isAuthnRequestsSignedXSBoolean

      @Nullable XSBooleanValue isAuthnRequestsSignedXSBoolean()
      Gets whether this service signs AuthN requests.
      Returns:
      true of this service signs requests, false if not

    • setAuthnRequestsSigned

      void setAuthnRequestsSigned(@Nullable Boolean newIsSigned)
      Sets whether this service signs AuthN requests. Boolean values will be marshalled to either "true" or "false".
      Parameters:
      newIsSigned - true of this service signs requests, false if not

    • setAuthnRequestsSigned

      void setAuthnRequestsSigned(@Nullable XSBooleanValue newIsSigned)
      Sets whether this service signs AuthN requests.
      Parameters:
      newIsSigned - true of this service signs requests, false if not

    • getWantAssertionsSigned

      @Nullable Boolean getWantAssertionsSigned()
      Gets whether this service wants assertions signed.
      Returns:
      true if this service wants assertions signed, false if not

    • getWantAssertionsSignedXSBoolean

      @Nullable XSBooleanValue getWantAssertionsSignedXSBoolean()
      Gets whether this service wants assertions signed.
      Returns:
      true if this service wants assertions signed, false if not

    • setWantAssertionsSigned

      void setWantAssertionsSigned(@Nullable Boolean newWantAssestionSigned)
      Sets whether this service wants assertions signed. Boolean values will be marshalled to either "true" or "false".
      Parameters:
      newWantAssestionSigned - true if this service wants assertions signed, false if not

    • setWantAssertionsSigned

      void setWantAssertionsSigned(@Nullable XSBooleanValue newWantAssestionSigned)
      Sets whether this service wants assertions signed.
      Parameters:
      newWantAssestionSigned - true if this service wants assertions signed, false if not

    • getAssertionConsumerServices

      @Nonnull @Live List<AssertionConsumerService> getAssertionConsumerServices()
      Gets a list of assertion consumer service Endpoints for this service.
      Returns:
      list of assertion consumer service Endpoints for this service

    • getDefaultAssertionConsumerService

      @Nullable AssertionConsumerService getDefaultAssertionConsumerService()
      Gets the default assertion consumer service.

      The selection algorithm used is:

      1. Select the first service with an explicit isDefault=true
      2. Select the first service with no explicit isDefault
      3. Select the first service
      Returns:
      default assertion consumer service (or null if there are no assertion consumer services defined)

    • getAttributeConsumingServices

      @Nonnull @Live List<AttributeConsumingService> getAttributeConsumingServices()
      Gets a list of attribute consuming service descriptors for this service.
      Returns:
      list of attribute consuming service descriptors for this service

    • getDefaultAttributeConsumingService

      @Nullable AttributeConsumingService getDefaultAttributeConsumingService()
      Gets the default attribute consuming service.

      The selection algorithm used is:

      1. Select the first service with an explicit isDefault=true
      2. Select the first service with no explicit isDefault
      3. Select the first service
      Returns:
      default attribute consuming service (or null if there are no attribute consuming services defined)