co.blustor.gatekeepersdk.services

Class GKAuthentication

java.lang.Object

co.blustor.gatekeepersdk.services.GKAuthentication

public class GKAuthentication
extends java.lang.Object

GKAuthentication is a Service for using facial authentication with the GateKeeper Card.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GKAuthentication.AuthResult AuthResult encapsulates the result of basic authentication actions.
class	GKAuthentication.ListTemplatesResult ListTemplatesResult encapsulates the result of the "List Templates" action.
static class	GKAuthentication.Status Status is the named result of an action.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENROLL_FACE_PATH_PREFIX
static java.lang.String	ENROLL_RECOVERY_CODE_PATH_PREFIX
static java.lang.String	LIST_FACE_PATH
static java.lang.String	LIST_RECOVERY_CODE_PATH
protected GKCard	mCard
static java.lang.String	REVOKE_FACE_PATH_PREFIX
static java.lang.String	REVOKE_RECOVERY_CODE_PATH_PREFIX
static java.lang.String	SIGN_IN_FACE_PATH
static java.lang.String	SIGN_IN_RECOVERY_CODE_PATH
static java.lang.String	SIGN_OUT_PATH
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
GKAuthentication(GKCard card) Create a GKAuthentication that communicates with card.

Method Summary

Modifier and Type	Method and Description
GKAuthentication.AuthResult	enrollWithFace(GKFaces.Template template) Store a Template at the first template index on the GateKeeper Card.
GKAuthentication.AuthResult	enrollWithFace(GKFaces.Template template, java.lang.String templateId) Store a Template at the given template index on the GateKeeper Card.
GKAuthentication.AuthResult	enrollWithRecoveryCode(java.lang.String recoveryCode) Store a recovery code at the first template index on the GateKeeper Card.
GKAuthentication.AuthResult	enrollWithRecoveryCode(java.lang.String recoveryCode, java.lang.String templateId) Store a recovery code at the given template index on the GateKeeper Card.
GKAuthentication.ListTemplatesResult	listFaceTemplates() Retrieve the list of face templates stored on the GateKeeper Card.
GKAuthentication.ListTemplatesResult	listRecoveryCodeTemplates() Retrieve the list of recovery code templates stored on the GateKeeper Card.
GKAuthentication.AuthResult	revokeFace() Delete the Template at the first template index on the GateKeeper Card.
GKAuthentication.AuthResult	revokeFace(java.lang.String templateId) Delete the Template at the given template index on the GateKeeper Card.
GKAuthentication.AuthResult	revokeRecoveryCode() Delete the recovery code on the GateKeeper Card.
GKAuthentication.AuthResult	revokeRecoveryCode(java.lang.String templateId) Delete the recovery code on the GateKeeper Card.
GKAuthentication.AuthResult	signInWithFace(GKFaces.Template template) Authenticate with the GateKeeper Card using a Template.
GKAuthentication.AuthResult	signInWithRecoveryCode(java.lang.String recoveryCode) Authenticate with the GateKeeper Card using a recovery code.
GKAuthentication.AuthResult	signOut() End the current session on the GateKeeper Card.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

ENROLL_FACE_PATH_PREFIX

public static final java.lang.String ENROLL_FACE_PATH_PREFIX

See Also:

Constant Field Values

ENROLL_RECOVERY_CODE_PATH_PREFIX

public static final java.lang.String ENROLL_RECOVERY_CODE_PATH_PREFIX

See Also:

Constant Field Values

LIST_FACE_PATH

public static final java.lang.String LIST_FACE_PATH

See Also:

Constant Field Values

LIST_RECOVERY_CODE_PATH

public static final java.lang.String LIST_RECOVERY_CODE_PATH

See Also:

Constant Field Values

REVOKE_FACE_PATH_PREFIX

public static final java.lang.String REVOKE_FACE_PATH_PREFIX

See Also:

Constant Field Values

REVOKE_RECOVERY_CODE_PATH_PREFIX

public static final java.lang.String REVOKE_RECOVERY_CODE_PATH_PREFIX

See Also:

Constant Field Values

SIGN_IN_FACE_PATH

public static final java.lang.String SIGN_IN_FACE_PATH

See Also:

Constant Field Values

SIGN_IN_RECOVERY_CODE_PATH

public static final java.lang.String SIGN_IN_RECOVERY_CODE_PATH

See Also:

Constant Field Values

SIGN_OUT_PATH

public static final java.lang.String SIGN_OUT_PATH

See Also:

Constant Field Values

mCard

protected final GKCard mCard

Constructor Detail

GKAuthentication

public GKAuthentication(GKCard card)

Create a GKAuthentication that communicates with card.

Parameters:

card - the GKCard to be used with facial authentication actions

Since:

0.5.0

Method Detail

enrollWithFace

public GKAuthentication.AuthResult enrollWithFace(GKFaces.Template template)
                                           throws java.io.IOException

Store a Template at the first template index on the GateKeeper Card.

Parameters:

template - the Template to be stored

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.12.0

enrollWithFace

public GKAuthentication.AuthResult enrollWithFace(GKFaces.Template template,
                                                  java.lang.String templateId)
                                           throws java.io.IOException

Store a Template at the given template index on the GateKeeper Card.

Parameters:

template - the Template to be stored

templateId - the name of the file at which to store the template

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.12.0

enrollWithRecoveryCode

public GKAuthentication.AuthResult enrollWithRecoveryCode(java.lang.String recoveryCode)
                                                   throws java.io.IOException

Store a recovery code at the first template index on the GateKeeper Card.

Parameters:

recoveryCode - the String to be stored

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.10.0

enrollWithRecoveryCode

public GKAuthentication.AuthResult enrollWithRecoveryCode(java.lang.String recoveryCode,
                                                          java.lang.String templateId)
                                                   throws java.io.IOException

Store a recovery code at the given template index on the GateKeeper Card.

Parameters:

recoveryCode - the String to be stored

templateId - the id at which to store the recovery code

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.10.0

signInWithFace

public GKAuthentication.AuthResult signInWithFace(GKFaces.Template template)
                                           throws java.io.IOException

Authenticate with the GateKeeper Card using a Template.

Parameters:

template - the Template to be submitted for authentication

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.5.0

signInWithRecoveryCode

public GKAuthentication.AuthResult signInWithRecoveryCode(java.lang.String recoveryCode)
                                                   throws java.io.IOException

Authenticate with the GateKeeper Card using a recovery code.

Parameters:

recoveryCode - the String to be submitted for authentication

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.5.0

signOut

public GKAuthentication.AuthResult signOut()
                                    throws java.io.IOException

End the current session on the GateKeeper Card.

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.5.0

revokeFace

public GKAuthentication.AuthResult revokeFace()
                                       throws java.io.IOException

Delete the Template at the first template index on the GateKeeper Card.

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.5.0

revokeFace

public GKAuthentication.AuthResult revokeFace(java.lang.String templateId)
                                       throws java.io.IOException

Delete the Template at the given template index on the GateKeeper Card.

Parameters:

templateId - the id at which to delete a template

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.5.0

revokeRecoveryCode

public GKAuthentication.AuthResult revokeRecoveryCode()
                                               throws java.io.IOException

Delete the recovery code on the GateKeeper Card.

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.6.1

revokeRecoveryCode

public GKAuthentication.AuthResult revokeRecoveryCode(java.lang.String templateId)
                                               throws java.io.IOException

Delete the recovery code on the GateKeeper Card.

Parameters:

templateId - the index at which to delete a recovery code

Returns:

the AuthResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.6.1

listFaceTemplates

public GKAuthentication.ListTemplatesResult listFaceTemplates()
                                                       throws java.io.IOException

Retrieve the list of face templates stored on the GateKeeper Card.

Returns:

the ListTemplatesResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.9.0

listRecoveryCodeTemplates

public GKAuthentication.ListTemplatesResult listRecoveryCodeTemplates()
                                                               throws java.io.IOException

Retrieve the list of recovery code templates stored on the GateKeeper Card.

Returns:

the ListTemplatesResult of the action

Throws:

java.io.IOException - when communication with the GateKeeper Card has been disrupted.

Since:

0.9.0