FingerprintBiometricData (BlackBerry JDE 7.1.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.biometrics
Class FingerprintBiometricData

java.lang.Object
  net.rim.device.api.biometrics.BiometricData
      net.rim.device.api.biometrics.FingerprintBiometricData

All Implemented Interfaces:: Persistable

public class FingerprintBiometricData
extends BiometricData
implements Persistable
extends BiometricData
implements Persistable

A container for storing fingerprint biometric data.

Constant data provided by this class

The static data members in this class are organized into several types.

FINGERPRINT_TYPE_x: These members all describe various ways of encoding fingerprint data. Note that you should use the special type FingerprintBiometricData.FINGERPRINT_TYPE_UNKNOWN when you don't know the specific encoding for the fingerprint data.

FINGERPRINT_ID_x: These members are used to identify the particular finger(s) on the hand that provided the fingerprint data. Note that you should use the special type FingerprintBiometricData.FINGER_ID_UNKNOWN when you don't know which finger(s) provided the data.

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

Field Summary
	`static int`	`FINGERPRINT_TYPE_ATRUA` Atrua propritary format.
	`static int`	`FINGERPRINT_TYPE_ISO_19794_FMR` ISO 19794-2 FMR format (encodes multiple views, and so on).
	`static int`	`FINGERPRINT_TYPE_ISO_COMPACT_CARD` ISO 19794-2 compact card (lossy) format.
	`static int`	`FINGERPRINT_TYPE_ISO_COMPACT_CARD_CBEFF` ISO 19794-2 compact card (lossy) format with CBEFF wrapper.
	`static int`	`FINGERPRINT_TYPE_ISO_NORMAL_CARD` ISO 19794-2 normal card (50 minu max) format.
	`static int`	`FINGERPRINT_TYPE_ISO_NORMAL_CARD_CBEFF` ISO 19794-2 normal card (50 minu max) format with CBEFF wrapper.
	`static int`	`FINGERPRINT_TYPE_PIV` FIPS201 format employed by the U.S. government.
	`static int`	`FINGERPRINT_TYPE_PIV_CBEFF` FIPS201 format employed by the U.S. government, with CBEFF wrapper.
	`static int`	`FINGERPRINT_TYPE_UNKNOWN` Unknown format.
	`static int`	`FINGER_ID_LEFT_INDEX` Left index finger.
	`static int`	`FINGER_ID_LEFT_LITTLE` Left little finger Data was sampled from the little finger on a left hand.
	`static int`	`FINGER_ID_LEFT_MIDDLE` Left middle finger.
	`static int`	`FINGER_ID_LEFT_RING` Left ring finger.
	`static int`	`FINGER_ID_LEFT_THUMB` Left thumb.
	`static int`	`FINGER_ID_RIGHT_INDEX` Right index finger.
	`static int`	`FINGER_ID_RIGHT_LITTLE` Right little finger.
	`static int`	`FINGER_ID_RIGHT_MIDDLE` Right middle finger.
	`static int`	`FINGER_ID_RIGHT_RING` Right ring finger.
	`static int`	`FINGER_ID_RIGHT_THUMB` Right thumb.
	`static int`	`FINGER_ID_UNKNOWN` Unknown finger.
	`static int`	`NUM_FINGERS` Total number of fingers on both hands.

Constructor Summary
	`FingerprintBiometricData(byte[] fingerprint, int fingerprintType, int[] fingerprintIDs)` Create a new biometric data instance to contain the sample data for a number of fingerprints.

Method Summary
	`byte[]`	`getFingerprint()` Retrieve the sampled fingerprint data.
	`int[]`	`getFingerprintIDs()` Retrieve the positions of the fingers from which these samples were gathered.
	`int`	`getFingerprintType()` Retrieve the encoding for this fingerprint sample.
	`void`	`set(byte[] fingerprint, int fingerprintType)` Provide newly encoded sample data.
	`void`	`set(byte[] fingerprint, int fingerprintType, int[] fingerprintIDs)` Provide an entirely new set of sample data.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

FINGERPRINT_TYPE_ISO_COMPACT_CARD

public static final int FINGERPRINT_TYPE_ISO_COMPACT_CARD

ISO 19794-2 compact card (lossy) format.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_ISO_COMPACT_CARD_CBEFF

public static final int FINGERPRINT_TYPE_ISO_COMPACT_CARD_CBEFF

ISO 19794-2 compact card (lossy) format with CBEFF wrapper.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_PIV

public static final int FINGERPRINT_TYPE_PIV

FIPS201 format employed by the U.S. government.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_PIV_CBEFF

public static final int FINGERPRINT_TYPE_PIV_CBEFF

FIPS201 format employed by the U.S. government, with CBEFF wrapper.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_ISO_NORMAL_CARD

public static final int FINGERPRINT_TYPE_ISO_NORMAL_CARD

ISO 19794-2 normal card (50 minu max) format.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_ISO_NORMAL_CARD_CBEFF

public static final int FINGERPRINT_TYPE_ISO_NORMAL_CARD_CBEFF

ISO 19794-2 normal card (50 minu max) format with CBEFF wrapper.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_ISO_19794_FMR

public static final int FINGERPRINT_TYPE_ISO_19794_FMR

ISO 19794-2 FMR format (encodes multiple views, and so on).

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_ATRUA

public static final int FINGERPRINT_TYPE_ATRUA

Atrua propritary format.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGERPRINT_TYPE_UNKNOWN

public static final int FINGERPRINT_TYPE_UNKNOWN

Unknown format.

Special value to be used when the contained data is in an unknown format.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_UNKNOWN

public static final int FINGER_ID_UNKNOWN

Unknown finger.

Special value to be used when it's not known or specified which finger on the hand the contained data belongs to.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_LEFT_THUMB

public static final int FINGER_ID_LEFT_THUMB

Left thumb.

Data was sampled from the thumb on a left hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_LEFT_INDEX

public static final int FINGER_ID_LEFT_INDEX

Left index finger.

Data was sampled from the index finger on a left hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_LEFT_MIDDLE

public static final int FINGER_ID_LEFT_MIDDLE

Left middle finger.

Data was sampled from the middle finger on a left hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_LEFT_RING

public static final int FINGER_ID_LEFT_RING

Left ring finger.

Data was sampled from the ring finger on a left hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_LEFT_LITTLE

public static final int FINGER_ID_LEFT_LITTLE

Left little finger

Data was sampled from the little finger on a left hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_RIGHT_THUMB

public static final int FINGER_ID_RIGHT_THUMB

Right thumb.

Data was sampled from the thumb on a right hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_RIGHT_INDEX

public static final int FINGER_ID_RIGHT_INDEX

Right index finger.

Data was sampled from the index finger on a right hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_RIGHT_MIDDLE

public static final int FINGER_ID_RIGHT_MIDDLE

Right middle finger.

Data was sampled from the middle finger on a right hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_RIGHT_RING

public static final int FINGER_ID_RIGHT_RING

Right ring finger.

Data was sampled from the ring finger on a right hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

FINGER_ID_RIGHT_LITTLE

public static final int FINGER_ID_RIGHT_LITTLE

Right little finger.

Data was sample from the little finger on a right hand.

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

NUM_FINGERS

public static final int NUM_FINGERS

Total number of fingers on both hands.

Convenience value you can use for checking that the finger ID associated with sampled data is within a valid range (that is, 0 <= fingerID < NUM_FINGERS).

See Also:: Constant Field Values
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

Constructor Detail

FingerprintBiometricData

public FingerprintBiometricData(byte[] fingerprint,
                                int fingerprintType,
                                int[] fingerprintIDs)

Create a new biometric data instance to contain the sample data for a number of fingerprints.

Usage note: Some fingerprint encodings are designed to contain sample data for multiple fingerprints (for example, encodings with CBEFF). Additionally, some encodings directly contain an identification of the finger from which each sample was taken. To avoid confusion, when you instantiate this container, you should fully enumerate your list of fingerprint IDs, so that each sampled fingerprint has an associated ID to identify the finger sampled, even if one or more of the finger IDs is unknown (in which case, use the the value #FINGERPRINT_ID_UNKNOWN), or one or more of the sampled prints come from the same finger (in which case, repeat the ID for each sample).

Parameters:: fingerprint - Raw fingerprint sample data for one or more fingerprints.; fingerprintType - Encoding used for the sample (one of the FINGERPRINT_TYPE_* values; note that all the prints in a bundle of samples must be of the same encoding type).; fingerprintID - Array of values to identify the fingers from which the data was sampled (one or more of the FINGER_ID_* values).
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

Method Detail

set

public void set(byte[] fingerprint,
                int fingerprintType,
                int[] fingerprintIDs)

Provide an entirely new set of sample data.

Invoke this method to provide a new set of sample data (potentially changing the identification of the finger(s) from which the sample was gathered, as well as the encoding type.).

This method is intended as convenience method to allow for re-use of this container object for subsequent samplings of fingerprint data.

Parameters:: fingerprint - Raw fingerprint sample data for one or more fingerprints.; fingerprintType - Encoding used for the sample (one of the FINGERPRINT_TYPE_* values; note that all the prints in a bundle of samples must be of the same encoding type).; fingerprintID - Array of values to identify the fingers from which the data was sampled (one or more of the FINGER_ID_* values).
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

set

public void set(byte[] fingerprint,
                int fingerprintType)

Provide newly encoded sample data.

Invoke this method to provide a new set of sample data (potentially with a new encoding), without changing the identification of the finger(s) from which the sample was gathered.

Note: Notice that the new data you provide must match precisely with the order and number of fingers previously sampled. Accordingly, this method is intended as a convenience method for transcoding a set of existing fingerprint data. For re-use, it's safer to invoke FingerprintBiometricData.set(byte[],int,int[]).

Parameters:: fingerprint - Raw fingerprint sample data for one or more fingerprints.; fingerprintType - Encoding used for the sample (one of the FINGERPRINT_TYPE_* values; note that all the prints in a bundle of samples must be of the same encoding type).
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

getFingerprint

public byte[] getFingerprint()

Retrieve the sampled fingerprint data.

Returns:: Raw fingerprint data stored in this container.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

getFingerprintIDs

public int[] getFingerprintIDs()

Retrieve the positions of the fingers from which these samples were gathered.

Returns:: Array of integer values you can match against the FINGER_ID static values to determine which fingers were sampled.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

getFingerprintType

public int getFingerprintType()

Retrieve the encoding for this fingerprint sample.

Returns:: Integer value you can match against one of the FINGERPRINT_TYPE static values to determine what encoding type was used for this instance's sampled data. This method returns the FingerprintBiometricData.FINGERPRINT_TYPE_UNKNOWN special value if the encoding for this instance's sampled data is not known.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0