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

Interface DispatchContext.MobileSdkDispatcherResponseBuilder

Enclosing interface:
DispatchContext
public static interface DispatchContext.MobileSdkDispatcherResponseBuilder
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.

  • Method Details

    • redeemUrl

      DispatchContext.MobileSdkDispatcherResponseBuilder redeemUrl(URI redeemUrl)
      The redeem URL that must be included in the out-of-band payload. This is required by the Nevis Mobile Authentication SDK to know which is the URL that must be used to redeem the token.

      In the case of the out-of-the box dispatchers of nevisFIDO, this is obtained from the nevisfido.yml file by implementing the Configurable interface.

      Providing the redeem URL is required.

      Parameters:
      redeemUrl - the redeem URL.
      Returns:
      a MobileSdkDispatcherResponseBuilder

    • outOfBandPayloadData

      DispatchContext.MobileSdkDispatcherResponseBuilder outOfBandPayloadData(@Nullable String outOfBandPayloadData)
      The additional data that can be included as part of the out-of-band payload. This data can be retrieved by the client using the SDK through OutOfBandPayload.datajava swift objc flutter react native.

      Providing this data is optional.

      Parameters:
      outOfBandPayloadData - the additional data to be included in the out-of-band payload.
      Returns:
      a MobileSdkOutOfBandPayloadBuilder
      See Also:

    • statusResponse

      DispatchContext.MobileSdkDispatcherResponseBuilder statusResponse(String status)
      The value of the tokenInformation.dispatcherInformation.response attribute returned by the status service. The status service informs about operations, and this attribute can be used to include information about the dispatching of the token.

      Providing the status information is required.

      Parameters:
      status - the status information to be exposed in the status service
      Returns:
      a MobileSdkDispatcherResponseBuilder
      See Also:

    • httpResponse

      DispatchContext.MobileSdkDispatcherResponseBuilder httpResponse(String response)
      The value of the response attribute included in the HTTP response returned to the HTTP client that invoked the dispatch token service.

      Providing the response information is required.

      Parameters:
      response - the information to be included in the HTTP response
      Returns:
      a MobileSdkDispatcherResponseBuilder
      See Also:

    • additionalInformation

      DispatchContext.MobileSdkDispatcherResponseBuilder additionalInformation(@Nullable String additionalInformation)
      Additional information that is not included in the out-of-band payload, but that is sent by the dispatcher and can be useful to the client receiving the dispatched token.

      This additional information is optional.

      Parameters:
      additionalInformation - the additional information
      Returns:
      a MobileSdkDispatcherResponseBuilder
      See Also:

    • build

      DispatcherResponse build() throws DispatchException
      Builds a DispatcherResponse.
      Returns:
      a DispatcherResponse
      Throws:
      DispatchException - if there is a problem generating the DispatchResponse