Package com.yubico.yubikit.fido.ctap

Class FingerprintBioEnrollment.Context

java.lang.Object

com.yubico.yubikit.fido.ctap.FingerprintBioEnrollment.Context

Enclosing class:

FingerprintBioEnrollment

public static class FingerprintBioEnrollment.Context
extends Object

Convenience class for handling one fingerprint enrollment

Constructor Summary

Constructors

Constructor	Description
Context(FingerprintBioEnrollment bioEnrollment, Integer timeout, byte[] templateId, Integer remaining)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels ongoing enrollment.
byte[]	capture(com.yubico.yubikit.core.application.CommandState state)	Capture a fingerprint sample.
Integer	getRemaining()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Context

public Context(FingerprintBioEnrollment bioEnrollment,
 @Nullable
 Integer timeout,
 @Nullable
 byte[] templateId,
 @Nullable
 Integer remaining)

Method Details

capture

@Nullable
public byte[] capture(@Nullable
 com.yubico.yubikit.core.application.CommandState state)
               throws IOException,
com.yubico.yubikit.core.application.CommandException,
FingerprintBioEnrollment.CaptureError

Capture a fingerprint sample.

This call will block for up to timeout milliseconds (or indefinitely, if timeout not specified) waiting for the user to scan their fingerprint to collect one sample.

Parameters:

state - If needed, the state to provide control over the ongoing operation.

Returns:

None, if more samples are needed, or the template ID if enrollment is completed.

Throws:

IOException - A communication error in the transport layer.

com.yubico.yubikit.core.application.CommandException - A communication error in the protocol layer.

FingerprintBioEnrollment.CaptureError - An error during fingerprint capture.

cancel

public void cancel()
            throws IOException,
com.yubico.yubikit.core.application.CommandException

Cancels ongoing enrollment.

Throws:

IOException

com.yubico.yubikit.core.application.CommandException

getRemaining

@Nullable
public Integer getRemaining()

Returns:

number of remaining captures for successful enrollment