Package se.swedenconnect.opensaml.saml2.response

Interface ResponseProcessingInput

public interface ResponseProcessingInput
Represents the input passed along with a SAML Response to the ResponseProcessor.
Author:
Martin Lindström (martin@idsec.se)

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opensaml.saml.saml2.core.AuthnRequest
    getAuthnRequest(String id)
    Returns the authentication request message that corresponds to the response message being processed.
    X509Certificate
    getClientCertificate()
    If the Holder-of-key WebSSO profile is in use, the client presented certificate is required.
    String
    getClientIpAddress()
    If the validation should perform a check of the Address(es) found in the assertion, this method should return the address of the client, otherwise return null.
    Instant
    getReceiveInstant()
    Returns the timestamp when the response was received.
    String
    getReceiveURL()
    Returns the URL on which the response message was received.
    String
    getRequestRelayState(String id)
    Returns the RelayState that was included in the request (or null if none was sent).

  • Method Details

    • getAuthnRequest

      org.opensaml.saml.saml2.core.AuthnRequest getAuthnRequest(String id)
      Returns the authentication request message that corresponds to the response message being processed.
      Parameters:
      id - the ID of the authentication request
      Returns:
      the AuthnRequest message or null if no message is available

    • getRequestRelayState

      String getRequestRelayState(String id)
      Returns the RelayState that was included in the request (or null if none was sent).
      Parameters:
      id - the ID of the authentication request
      Returns:
      the RelayState variable or null

    • getReceiveURL

      String getReceiveURL()
      Returns the URL on which the response message was received.
      Returns:
      the receive URL

    • getReceiveInstant

      Instant getReceiveInstant()
      Returns the timestamp when the response was received.
      Returns:
      the receive timestamp

    • getClientIpAddress

      String getClientIpAddress()
      If the validation should perform a check of the Address(es) found in the assertion, this method should return the address of the client, otherwise return null.
      Returns:
      the client IP address of null if no check should be made

    • getClientCertificate

      X509Certificate getClientCertificate()
      If the Holder-of-key WebSSO profile is in use, the client presented certificate is required.
      Returns:
      the client certificate, or null if none is available