Package org.forgerock.openam.authentication.callbacks

Class DeviceBindingCallback

java.lang.Object
org.forgerock.openam.authentication.callbacks.DeviceBindingCallback
All Implemented Interfaces:
Callback
@Supported public final class DeviceBindingCallback extends Object implements Callback
Class representative of a DeviceBindingCallback Object which instructs a client to handle Device Binding.

  • Method Details

    • getTitle

      @Supported public String getTitle()
      Return the title to be displayed in biometric prompt.
      Returns:
      The Title

    • getSubtitle

      @Supported public String getSubtitle()
      Return the subtitle to be displayed in biometric prompt.
      Returns:
      The subtitle

    • getDescription

      @Supported public String getDescription()
      Return the description to be displayed in biometric prompt.
      Returns:
      The description

    • getAuthenticationType

      @Supported public String getAuthenticationType()
      Return the Authentication Type to bind the device.
      Returns:
      The Authentication Type

    • getChallenge

      @Supported public String getChallenge()
      Return the challenge to be signed by the device.
      Returns:
      The challenge

    • getUserId

      @Supported public String getUserId()
      Return the user id of the user.
      Returns:
      The user id

    • getUsername

      @Supported public String getUsername()
      Return the username of the user.
      Returns:
      The username

    • getJws

      @Supported public String getJws()
      Return the Json Web Signature.
      Returns:
      The Json Web Signature

    • setJws

      @Supported public void setJws(String jws)
      Set the Json Web Signature.
      Parameters:
      jws - The Json Web Signature

    • getTimeout

      @Supported public Integer getTimeout()
      Return the timeout of the binding process.
      Returns:
      The timeout

    • getAttestation

      @Supported public Boolean getAttestation()
      Return the Android Key Attestation Options.
      Returns:
      The Key Attestation Options

    • getDeviceName

      @Supported public String getDeviceName()
      Return the device name for the bounded device.
      Returns:
      The device name

    • setDeviceName

      @Supported public void setDeviceName(String deviceName)
      Set the device name for the bounded device.
      Parameters:
      deviceName - The device name

    • getDeviceId

      @Supported public String getDeviceId()
      Return the device id for the bounded device.
      Returns:
      The Device Id

    • setDeviceId

      @Supported public void setDeviceId(String deviceId)
      Set the device id for the bounded device.
      Parameters:
      deviceId - The device ID

    • getClientError

      @Supported public String getClientError()
      Get the client error.
      Returns:
      The client Error

    • setClientError

      @Supported public void setClientError(String clientError)
      Set the client error.
      Parameters:
      clientError - The Client Error

    • builder

      @Supported public static DeviceBindingCallback.Builder builder()
      Get a builder for constructing a new DeviceBindingCallback.
      Returns:
      a new builder