Package se.curity.identityserver.sdk.oauth.consent.signing

Interface SigningConsentor

public interface SigningConsentor
This is interface should be implemented by the signing consentor plugins. The methods start and poll are called from the internal implementation to trigger the signing consentor flow and poll for the results respectively.
Since:
4.1.0

  • Method Details

    • start

      @Deprecated SigningConsentorResult start(String textToDisplay, String objectToSign)
      Deprecated.
      use start(String, String, ConsentAttributes) instead will continue the flow accordingly.
      Start the signing process with the external party.
      Parameters:
      textToDisplay - The text to show up on the third party application that will sign the objectToSign
      objectToSign - The actual object (e.g. JWT) to be signed via a third party
      Returns:
      SigningConsentorResult based on the type returned, then the internal implementation

    • start

      default SigningConsentorResult start(String textToDisplay, String objectToSign, ConsentAttributes consentAttributes)
      Start the signing process with the external party.
      Parameters:
      textToDisplay - The text to show up on the third party application that will sign the objectToSign
      objectToSign - The actual object (e.g. JWT) to be signed via a third party
      consentAttributes - The attributes to base the consent on
      Returns:
      SigningConsentorResult based on the type returned, then the internal implementation will continue the flow accordingly.
      Since:
      4.6.0

    • poll

      SigningConsentorResult poll()
      The poll method will poll the third party until the latter responds that the signing process is complete.
      Returns:
      SigningConsentorResult based on the typed returned, the flow continues to poll until done, or completes.

    • cancel

      void cancel()
      The cancel method will be used when the user cancels the ongoing consentor flow.