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

Interface DispatchTarget

public interface DispatchTarget
The entity with all the information associated with an entity to which tokens can be sent.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    deviceId()
    The optional identifier describing the device.
    Optional<String>
    encryptionKey()
    The optional encryption key that is used to encrypt the token before sending it through the dispatcher.
    String
    name()
    A user friendly name to identify this DispatchTarget.
    Optional<String>
    target()
    The target description.

  • Method Details

    • name

      String name()
      A user friendly name to identify this DispatchTarget. For example in the case of a target sending tokens to a mobile device, this could be Samsung Galaxy.
      Returns:
      the user friendly name

    • target

      Optional<String> target()
      The target description. This can be a simple identifier (for example fcm push identifier, or an email address) or a more complex data (like a tuple of email SMTP server and email address). It contains the information required by the dispatcher to dispatch a token.

      Some dispatchers (deep link, QR code) do not require a target: because of their nature the destination is implicit (i.e. they are dispatched to the nevisFIDO HTTP client). This is why this property is optional. This is useful for example in the case where no push notifications are needed.

      Returns:
      the target

    • encryptionKey

      Optional<String> encryptionKey()
      The optional encryption key that is used to encrypt the token before sending it through the dispatcher. It is a Json Web Key (JSON as String).
      Returns:
      the key to be used to encrypt the token

    • deviceId

      Optional<String> deviceId()
      The optional identifier describing the device. The goal of this attribute is to allow linking FIDO UAF credentials and the dispatch targets.
      Returns:
      the device ID