com.gemalto.idp.mobile.authentication.mode.pin

Class PinAuthService

java.lang.Object

com.gemalto.idp.mobile.authentication.mode.pin.PinAuthService

All Implemented Interfaces:

AuthService

public class PinAuthService
extends java.lang.Object
implements AuthService

Provides services for authentication with PIN.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<PinRule>	DEFAULT_PIN_RULES default PIN rules

Method Summary

Modifier and Type	Method and Description
static PinAuthService	create(AuthenticationModule module) Create PinAuthService instance using AuthenticationModule
PinAuthInput	createAuthInput(byte[] pinArrayToStore, boolean wipeSource) Create an PinAuthInput object.
PinAuthInput	createAuthInput(java.lang.String pinStringToStore) Create an PinAuthInput object.
PinAuthInput	createAuthInput(java.lang.String pinStringToStore, java.lang.String charsetName) Create an PinAuthInput object.
PinAuthMode	getAuthMode() Get authentication mode reference corresponding to this service.
boolean	isConfigured() Indicates if the authentication mode is configured and ready for use.
boolean	isSupported() Indicates if the authentication mode is supported by the hardware.
static void	setPinValidationRules(java.util.List<PinRule> pinRules)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PIN_RULES

public static final java.util.List<PinRule> DEFAULT_PIN_RULES

default PIN rules

Method Detail

create

public static PinAuthService create(AuthenticationModule module)

Create PinAuthService instance using AuthenticationModule

Parameters:

module - the AuthenticationModule.

Returns:

The PinAuthService instance.

createAuthInput

public PinAuthInput createAuthInput(java.lang.String pinStringToStore,
                                    java.lang.String charsetName)

Create an PinAuthInput object.

Parameters:

pinStringToStore - the Pin String to securely store

charsetName - The string will be converted to this character when stored in the SecureData object. It could be "UTF-8", "ISO-8859-15", "UTF-16", "US-ASCII", etc.

Returns:

PinAuthInput

createAuthInput

public PinAuthInput createAuthInput(java.lang.String pinStringToStore)

Create an PinAuthInput object.

Parameters:

pinStringToStore - The Pin string to securely store. The string will be converted to UTF-8 when stored in the SecureData object.

Returns:

PinAuthInput

createAuthInput

public PinAuthInput createAuthInput(byte[] pinArrayToStore,
                                    boolean wipeSource)

Create an PinAuthInput object.

Parameters:

pinArrayToStore - the pin byte array to securely store

wipeSource - If true, then the byte[] will be erased if the method returns successfully. Otherwise the input will not be modified.

Returns:

PinAuthInput

getAuthMode

public PinAuthMode getAuthMode()

Get authentication mode reference corresponding to this service.

Specified by:

getAuthMode in interface AuthService

Returns:

current auth mode.

setPinValidationRules

public static void setPinValidationRules(java.util.List<PinRule> pinRules)

isSupported

public boolean isSupported()

Indicates if the authentication mode is supported by the hardware.

Specified by:

isSupported in interface AuthService

Returns:

true if supported, else return false.

isConfigured

public boolean isConfigured()

Indicates if the authentication mode is configured and ready for use. For example, a user may need to configure the OS to use a particular feature, such as bio-fingerprint, before this authentication mode can be used.

Specified by:

isConfigured in interface AuthService

Returns:

true if configured, else return false.