概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

com.nttdocomo.opt.device
クラス FingerprintAuthenticator

Object
  |
  +--com.nttdocomo.opt.device.FingerprintAuthenticator
public class FingerprintAuthenticator
extends Object

携帯電話のネイティブの指紋認証機能にアクセスする手段を提供します。

端末によってサポートされていない場合があります。 未サポートの場合、メソッドが呼び出された時点でUnsupportedOperationExceptionが発生します。

導入されたバージョン:
DoJa-3.0

コンストラクタの概要
protected FingerprintAuthenticator()
           アプリケーションが直接このクラスのインスタンスを生成することはできません。
 
メソッドの概要
 int authenticate()
           指紋認証機能を呼び出して、デバイスに登録済みの全ての指紋データとの照合を行います。
 boolean authenticate(int id)
           指紋認証機能を呼び出して、指定された1つの指紋データとの照合を行います。
 int authenticate(int[] id)
           指紋認証機能を呼び出して、指定された複数の指紋データとの照合を行います。
static FingerprintAuthenticator getFingerprintAuthenticator()
           指紋認証オブジェクトを取得します。
 int select()
           ユーザ操作により指紋データのエントリIDを取得します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

FingerprintAuthenticator

protected FingerprintAuthenticator()
アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの詳細

getFingerprintAuthenticator

public static FingerprintAuthenticator getFingerprintAuthenticator()
指紋認証オブジェクトを取得します。 このメソッドでは、複数回呼び出された場合でも常に同じ値を返します。

戻り値:
指紋認証オブジェクトを返します。

select

public int select()
           throws com.nttdocomo.system.InterruptedOperationException
ユーザ操作により指紋データのエントリIDを取得します。

このメソッドが呼び出されるとJavaアプリケーションはサスペンドし、 ネイティブの指紋データ選択機能が起動されます。 端末によっては、ネイティブの選択機能の中から指紋データの新規登録などを行える場合もあります。 指紋データ選択機能が終了すると、Javaアプリケーションはレジュームします。

戻り値:
選択された指紋データに対応するエントリIDを返します。 ユーザが選択操作をキャンセルした場合や指紋データが1つも登録されていない場合は -1 を返します。
例外:
com.nttdocomo.lang.IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。
SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、指紋データのエントリIDを取得できない場合に発生します。
com.nttdocomo.system.InterruptedOperationException - 競合条件などにより、選択操作が異常終了した場合に発生します。

authenticate

public int authenticate()
                 throws com.nttdocomo.system.InterruptedOperationException
指紋認証機能を呼び出して、デバイスに登録済みの全ての指紋データとの照合を行います。

このメソッドが呼び出されるとJavaアプリケーションはサスペンドし、 ネイティブの指紋認証機能が起動されます。 指紋認証機能が終了すると、Javaアプリケーションはレジュームします。

戻り値:
指紋認証が成功した場合、成功した指紋データのエントリIDを返します。 失敗した場合やユーザが認証操作をキャンセルした場合、指紋データが1つも登録されていない場合は -1 を返します。
例外:
com.nttdocomo.lang.IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。
SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、指紋データのエントリIDを取得できない場合に発生します。
com.nttdocomo.system.InterruptedOperationException - 競合条件などにより、認証操作が異常終了した場合に発生します。

authenticate

public boolean authenticate(int id)
                     throws com.nttdocomo.system.StoreException,
                            com.nttdocomo.system.InterruptedOperationException
指紋認証機能を呼び出して、指定された1つの指紋データとの照合を行います。

このメソッドが呼び出されるとJavaアプリケーションはサスペンドし、 ネイティブの指紋認証機能が起動されます。 指紋認証機能が終了すると、Javaアプリケーションはレジュームします。

パラメータ:
id - 照合を行う、登録済み指紋データのエントリIDを指定します。
戻り値:
指紋認証が成功した場合はtrueを返します。 失敗した場合やユーザが認証操作をキャンセルした場合はfalseを返します。
例外:
com.nttdocomo.lang.IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。
SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、指紋データのエントリIDを取得できない場合に発生します。
com.nttdocomo.system.StoreException - 指定されたIDに対応する指紋データが存在しない場合に発生します(NOT_FOUND)。
com.nttdocomo.system.InterruptedOperationException - 競合条件などにより、認証操作が異常終了した場合に発生します。

authenticate

public int authenticate(int[] id)
                 throws com.nttdocomo.system.StoreException,
                        com.nttdocomo.system.InterruptedOperationException
指紋認証機能を呼び出して、指定された複数の指紋データとの照合を行います。 複数の指紋データの中のどの指紋との照合に成功したかを得ることができます。

このメソッドが呼び出されるとJavaアプリケーションはサスペンドし、 ネイティブの指紋認証機能が起動されます。 指紋認証機能が終了すると、Javaアプリケーションはレジュームします。

パラメータ:
id - 照合を行う、登録済み指紋データのエントリIDを指定します。
戻り値:
指紋認証が成功した場合、成功した指紋データのエントリIDを返します。 失敗した場合やユーザが認証操作をキャンセルした場合は -1 を返します。
例外:
com.nttdocomo.lang.IllegalStateException - 待ち受け実行時の非活性化状態で呼び出された場合に発生します。
NullPointerException - 引数idにnullが指定された場合に発生します。
IllegalArgumentException - 引数idの要素数が0の場合、あるいはサポートしている要素数を超えている場合に発生します。
SecurityException - ロック機能などのネイティブ独自のセキュリティ設定により、指紋データのエントリIDを取得できない場合に発生します。
com.nttdocomo.system.StoreException - 指定された全てのIDに対応する指紋データが存在しない場合に発生します(NOT_FOUND)。
com.nttdocomo.system.InterruptedOperationException - 競合条件などにより、認証操作が異常終了した場合に発生します。
概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

NTT DoCoMo,Inc.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ（その他に許諾者がある場合は当該許諾者も含めて）の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

「ｉモード」、「ｉアプリ／アイアプリ」、「ｉ-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。