Package se.swedenconnect.opensaml.saml2.request

Interface AuthnRequestGenerator

All Known Implementing Classes:
AbstractAuthnRequestGenerator, DefaultAuthnRequestGenerator
public interface AuthnRequestGenerator
Interface for generating AuthnRequest messages.
Author:
Martin Lindström (martin@idsec.se)

  • Method Details

    • generateAuthnRequest

      RequestHttpObject<org.opensaml.saml.saml2.core.AuthnRequest> generateAuthnRequest(String idpEntityID, String relayState, AuthnRequestGeneratorContext context) throws RequestGenerationException
      Generates a SAML authentication request message.
      Parameters:
      idpEntityID - the entityID of the IdP that we should send the request to
      relayState - the RelayState to include (may be null)
      context - the generator context (may be null)
      Returns:
      a request object
      Throws:
      RequestGenerationException - for errors during request generation

    • generateAuthnRequest

      RequestHttpObject<org.opensaml.saml.saml2.core.AuthnRequest> generateAuthnRequest(org.opensaml.saml.saml2.metadata.EntityDescriptor idp, String relayState, AuthnRequestGeneratorContext context) throws RequestGenerationException
      Generates a SAML authentication request message.
      Parameters:
      idp - the metadata for the IdP that we should send the request to
      relayState - the RelayState to include (may be null)
      context - the generator context (may be null)
      Returns:
      a request object
      Throws:
      RequestGenerationException - for errors during request generation

    • getSpEntityID

      String getSpEntityID()
      Gets the entityID for the service provider that this generator services.
      Returns:
      the SP entityID

    • getSignCredential

      org.opensaml.security.x509.X509Credential getSignCredential()
      Gets the signing credential to be used when signing the AuthnRequest messages.
      Returns:
      the signing credential, or null if no signing should be performed