org.researchstack.backbone.storage.file

Class PinCodeConfig

java.lang.Object

org.researchstack.backbone.storage.file.PinCodeConfig

public class PinCodeConfig
extends java.lang.Object

This class allows you to customize the type/strength of the pin code that the user must create to protect their data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PinCodeConfig.PinCodeType General PinCodeConfig.Types that should cover most desired pin code configs: Alpha, Numeric, and Alphanumberic.
static interface	PinCodeConfig.Type The interface that the PinCodeConfig.PinCodeType implements.

Constructor Summary

Constructors

Constructor and Description
PinCodeConfig() Constructs the default pin config, 4 digits and 5 minute lockout time
PinCodeConfig(long autoLockTime) Constructs a pin config with 4 digits and the provided lockout time
PinCodeConfig(PinCodeConfig.Type type, int length, long autoLockTime) Constructs a pin config with the specific type, character length, and lockout time

Method Summary

Modifier and Type	Method and Description
long	getPinAutoLockTime() Returns the amount of time in milliseconds that the user must be gone from the app for before they are prompted for their pin code again.
int	getPinLength() Returns the character length required for the pin
PinCodeConfig.Type	getPinType() Returns the pin type representing the restrictions on the pin code for the app
void	setPinAutoLockTime(long pinAutoLockTime) Sets the amount of time in milliseconds that the user must be gone from the app for before they are prompted for their pin code again.

Methods inherited from class java.lang.Object

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

Constructor Detail

PinCodeConfig

public PinCodeConfig()

Constructs the default pin config, 4 digits and 5 minute lockout time

PinCodeConfig

public PinCodeConfig(long autoLockTime)

Constructs a pin config with 4 digits and the provided lockout time

Parameters:

autoLockTime - the time before the user must re-enter their pin

PinCodeConfig

public PinCodeConfig(PinCodeConfig.Type type,
                     int length,
                     long autoLockTime)

Constructs a pin config with the specific type, character length, and lockout time

Parameters:

type - the PinCodeConfig.Type representing the pincode restrictions

length - the character length of the pin code

autoLockTime - the time before the user must re-enter their pin

Method Detail

getPinType

public PinCodeConfig.Type getPinType()

Returns the pin type representing the restrictions on the pin code for the app

Returns:

the pin type

getPinLength

public int getPinLength()

Returns the character length required for the pin

Returns:

the pin length

getPinAutoLockTime

public long getPinAutoLockTime()

Returns the amount of time in milliseconds that the user must be gone from the app for before they are prompted for their pin code again.

Returns:

the lockout time

setPinAutoLockTime

public void setPinAutoLockTime(long pinAutoLockTime)

Sets the amount of time in milliseconds that the user must be gone from the app for before they are prompted for their pin code again.

This may be a setting in your app, and therefore can be updated at any time.

Parameters:

pinAutoLockTime - the lockout time