org.simalliance.openmobileapi

Class AuthenticationProvider.PinID

java.lang.Object

org.simalliance.openmobileapi.AuthenticationProvider.PinID

Enclosing class:

AuthenticationProvider

public class AuthenticationProvider.PinID
extends java.lang.Object

This PIN ID uniquely identifies a PIN in the Secure Element system. The PIN ID is defined as specified in ISO/IEC 7816-4 and can be used to reference a PIN in an ISO/IEC 7816-4 compliant system.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ID_VALUE The maximum possible value of a PIN ID.
static int	MIN_ID_VALUE The minimum possible value of a PIN ID.

Constructor Summary

Constructors

Constructor and Description
AuthenticationProvider.PinID(int id, boolean local) Creates a PIN ID (reference) to identify a PIN within a Secure Element.

Method Summary

Methods

Modifier and Type	Method and Description
int	getID() Returns the PIN ID.
boolean	isLocal() Identifies if the PIN is local or global.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_ID_VALUE

public static final int MIN_ID_VALUE

The minimum possible value of a PIN ID.

See Also:

Constant Field Values

MAX_ID_VALUE

public static final int MAX_ID_VALUE

The maximum possible value of a PIN ID.

See Also:

Constant Field Values

Constructor Detail

AuthenticationProvider.PinID

public AuthenticationProvider.PinID(int id,
                            boolean local)
                             throws java.lang.IllegalArgumentException

Creates a PIN ID (reference) to identify a PIN within a Secure Element. The created PIN ID (as immutable object) can be specified on all PIN operation methods provided by the AuthenticationProvider class.

Note: This constructor is based on the P2 reference data for PIN related commands as specified in ISO/IEC 7816-4 in chapter 7.5 (Basic security handling). Local set to true indicates specific reference data and local set to false indicates global reference data according to ISO/IEC 7816-4. The ID indicates the number of the reference data (qualifier) according to ISO/IEC 7816-4.

Parameters:

id - The ID of the PIN (value from 0x00 to 0x1F).

local - Defines the scope (global or local). True if the PIN is local. Otherwise false.

Throws:

java.lang.IllegalArgumentException - if the defined ID is invalid.

Method Detail

getID

public final int getID()

Returns the PIN ID.

Note: This method is based on the P2 reference data for PIN related commands as specified in ISO/IEC 7816-4 in chapter 7.5 (Basic security handling). The ID indicates the number of the reference data (qualifier) according to ISO/IEC 7816-4.

Returns:

The PIN ID.

isLocal

public final boolean isLocal()

Identifies if the PIN is local or global.

Note: This method is based on the P2 reference data for PIN related commands as specified in ISO/IEC 7816-4 in chapter 7.5 (Basic security handling). Local set to true indicates specific reference data and local set to false indicates global reference data according to ISO/IEC 7816-4.

Returns:

True if the PIN is local. Otherwise false.