Package org.springframework.security.saml2.provider.service.registration

Interface AssertingPartyMetadata

All Known Implementing Classes:
OpenSamlAssertingPartyDetails, RelyingPartyRegistration.AssertingPartyDetails
public interface AssertingPartyMetadata
An interface representing SAML 2.0 Asserting Party metadata
Since:
6.4

  • Method Details

    • getEntityId

      String getEntityId()
      Get the asserting party's EntityID.

      Equivalent to the value found in the asserting party's <EntityDescriptor EntityID="..."/>

      This value may contain a number of placeholders, which need to be resolved before use. They are baseUrl, registrationId, baseScheme, baseHost, and basePort.

      Returns:
      the asserting party's EntityID

    • getWantAuthnRequestsSigned

      boolean getWantAuthnRequestsSigned()
      Get the WantAuthnRequestsSigned setting, indicating the asserting party's preference that relying parties should sign the AuthnRequest before sending.
      Returns:
      the WantAuthnRequestsSigned value

    • getSigningAlgorithms

      List<String> getSigningAlgorithms()
      Get the list of org.opensaml.saml.ext.saml2alg.SigningMethod Algorithms for this asserting party, in preference order.

      Equivalent to the values found in <SigningMethod Algorithm="..."/> in the asserting party's <IDPSSODescriptor>.

      Returns:
      the list of SigningMethod Algorithms
      Since:
      5.5

    • getVerificationX509Credentials

      Collection<Saml2X509Credential> getVerificationX509Credentials()
      Get all verification Saml2X509Credentials associated with this asserting party
      Returns:
      all verification Saml2X509Credentials associated with this asserting party
      Since:
      5.4

    • getEncryptionX509Credentials

      Collection<Saml2X509Credential> getEncryptionX509Credentials()
      Get all encryption Saml2X509Credentials associated with this asserting party
      Returns:
      all encryption Saml2X509Credentials associated with this asserting party
      Since:
      5.4

    • getSingleSignOnServiceLocation

      String getSingleSignOnServiceLocation()
      Get the SingleSignOnService Location.

      Equivalent to the value found in <SingleSignOnService Location="..."/> in the asserting party's <IDPSSODescriptor>.

      Returns:
      the SingleSignOnService Location

    • getSingleSignOnServiceBinding

      Saml2MessageBinding getSingleSignOnServiceBinding()
      Get the SingleSignOnService Binding.

      Equivalent to the value found in <SingleSignOnService Binding="..."/> in the asserting party's <IDPSSODescriptor>.

      Returns:
      the SingleSignOnService Location

    • getSingleLogoutServiceLocation

      String getSingleLogoutServiceLocation()
      Get the SingleLogoutService Location

      Equivalent to the value found in <SingleLogoutService Location="..."/> in the asserting party's <IDPSSODescriptor>.

      Returns:
      the SingleLogoutService Location
      Since:
      5.6

    • getSingleLogoutServiceResponseLocation

      String getSingleLogoutServiceResponseLocation()
      Get the SingleLogoutService Response Location

      Equivalent to the value found in <SingleLogoutService Location="..."/> in the asserting party's <IDPSSODescriptor>.

      Returns:
      the SingleLogoutService Response Location
      Since:
      5.6

    • getSingleLogoutServiceBinding

      Saml2MessageBinding getSingleLogoutServiceBinding()
      Get the SingleLogoutService Binding

      Equivalent to the value found in <SingleLogoutService Binding="..."/> in the asserting party's <IDPSSODescriptor>.

      Returns:
      the SingleLogoutService Binding
      Since:
      5.6

    • mutate

      AssertingPartyMetadata.Builder<?> mutate()