Package ch.nevis.auth.fido.uaf.sdk.dispatcher

Interface DispatchContext

public interface DispatchContext
The interface containing the information needed to dispatch a token
See Also:

  • Method Details

    • operation

      Operation operation()
      The type of the FIDO UAF operation associated with the token that must be dispatched: registration, authentication or deregistration.
      Returns:
      the operation

    • token

      String token()
      The token that must be dispatched
      Returns:
      the token

    • dispatchTarget

      Optional<DispatchTarget> dispatchTarget()
      If the HTTP client triggering the dispatch operation required to use a dispatch target by providing a dispatch target ID, this method returns the associated DispatchTarget.
      Returns:
      the dispatch target

    • dispatchInformation

      Optional<String> dispatchInformation()
      The information provided by the client required to complete the dispatch. The nature of this information depends on each dispatcher and is optional.

      For example the out-of-the box QR code dispatcher allows to provide parameters about the QR code like color, width or height of the QR code to be generated. See the nevisFIDO documentation for an example.

      Returns:
      the dispatch information (if any)

    • mobileSdkDispatcherResponseBuilder

      DispatchContext.MobileSdkDispatcherResponseBuilder mobileSdkDispatcherResponseBuilder()
      Returns an object that can be used to build a DispatcherResponse that is compatible with the Nevis Mobile Authentication SDK. This builder will take care of generating an out-of-band payload with the format expected by the Nevis Mobile Authentication SDK.
      Returns:
      an object that can generate DispatcherResponse objects compatible with the Nevis Mobile Authentication SDK

    • mobileSdkOutOfBandPayloadBuilder

      DispatchContext.MobileSdkOutOfBandPayloadBuilder mobileSdkOutOfBandPayloadBuilder()
      Returns an object that can be used to build an out-of-band payload that is compatible with the Nevis Mobile Authentication SDK. This builder will take care of generating an out-of-band payload with the format expected by the Nevis Mobile Authentication SDK. The payload will have encrypted contents if the DispatchContext has a DispatchTarget. To see how to use the payload in the Nevis Mobile SDK, check Obtain an out-of-band payload.
      Returns:
      an object that can generate and out-of-band payload that is compatible with the Nevis Mobile Authentication SDK