Package javacard.framework

Class OwnerPINBuilder

java.lang.Object

javacard.framework.OwnerPINBuilder

public class OwnerPINBuilder
extends Object

The OwnerPINBuilder class is factory for Owner PIN objects.

Since:

3.0.5

See Also:

OwnerPIN, OwnerPINx, OwnerPINxWithPredecrement

Field Summary

Fields

Modifier and Type	Field	Description
static byte	OWNER_PIN	The type identifier for the legacy OwnerPIN.
static byte	OWNER_PIN_X	The type identifier for OwnerPINx.
static byte	OWNER_PIN_X_WITH_PREDECREMENT	The type identifier for OwnerPINxWithPredecrement.

Method Summary

Modifier and Type	Method	Description
static PIN	buildOwnerPIN(byte tryLimit, byte maxPINSize, byte ownerPINType)	Creates a new PIN instance of the requested type, maximum allowed PIN size and tries limit, and with the validated flag initially set to false.

Methods inherited from class java.lang.Object

equals

Field Detail

OWNER_PIN

public static final byte OWNER_PIN

The type identifier for the legacy OwnerPIN.

See Also:

Constant Field Values

OWNER_PIN_X

public static final byte OWNER_PIN_X

The type identifier for OwnerPINx. OwnerPINx - when compared to the legacy OwnerPIN - allows for changing the tries limit.

See Also:

OwnerPINx.setTryLimit(byte), Constant Field Values

OWNER_PIN_X_WITH_PREDECREMENT

public static final byte OWNER_PIN_X_WITH_PREDECREMENT

The type identifier for OwnerPINxWithPredecrement. OwnerPINxWithPredecrement - when compared to OwnerPINx - supports the decrementation of the tries counter before any PIN validation attempts.

See Also:

OwnerPINxWithPredecrement.decrementTriesRemaining(), Constant Field Values

Method Detail

buildOwnerPIN

public static PIN buildOwnerPIN(byte tryLimit,
                                byte maxPINSize,
                                byte ownerPINType)
                         throws PINException

Creates a new PIN instance of the requested type, maximum allowed PIN size and tries limit, and with the validated flag initially set to false.

Parameters:

tryLimit - the maximum number of times an incorrect PIN can be presented; tryLimit must be >=1.

maxPINSize - the maximum allowed PIN size; maxPINSize must be >=1.

ownerPINType - the requested Owner PIN type. Valid codes listed in OWNER_* constants in this class e.g. OWNER_PIN_X.

Returns:

a new PIN instance.

Throws:

PINException - with the following reason codes:

• ILLEGAL_VALUE if tryLimit or maxPINSize is less than 1 or if ownerPINType is not one of the defined valid codes.

SystemException - with the following reason codes:

• ILLEGAL_USE if the PIN type ownerPINType is not implemented.