Package se.swedenconnect.bankid.rpapi.service

Interface BankIDClient

All Known Implementing Classes:
BankIDClientImpl
public interface BankIDClient
An interface that declares the methods for a BankID Relying Party (client).
Author:
Martin Lindström

  • Method Details

    • getIdentifier

      String getIdentifier()
      The unique identifier for this client. This is mainly important when we use more than one client, for example if we implement an IdP that serves several relying parties, and each RP has a client of its own.
      Returns:
      the unique identifier

    • authenticate

      reactor.core.publisher.Mono<OrderResponse> authenticate(AuthenticateRequest request)
      Initiates an authentication operation.
      Parameters:
      request - the authentication request parameters
      Returns:
      an OrderResponse

    • sign

      reactor.core.publisher.Mono<OrderResponse> sign(SignatureRequest request)
      Initiates a signature operation.
      Parameters:
      request - the signature request parameters
      Returns:
      an OrderResponse

    • cancel

      reactor.core.publisher.Mono<Void> cancel(String orderReference)
      Cancels an ongoing order.
      Parameters:
      orderReference - the order reference
      Throws:
      BankIDException - for errors

    • collect

      reactor.core.publisher.Mono<? extends CollectResponse> collect(String orderReference)
      Collects the result from authenticate(AuthenticateRequest) or sign(SignatureRequest).
      Parameters:
      orderReference - the unique order reference
      Returns:
      a collect response object
      Throws:
      UserCancelException - if the user cancels the operation
      BankIDException - for errors

    • getQRGenerator

      QRGenerator getQRGenerator()
      Returns the QR generator that should be used to generate QR codes.
      Returns:
      a QRGenerator or null if no QR code generator has been configured