public abstract class MessageDigest extends MessageDigestSpi
MessageDigest オブジェクトは、初期化されて起動されます。データは、MessageDigest オブジェクトを介して update メソッドを使用して処理されます。reset メソッドを呼び出すことにより、任意の時点でダイジェストをリセットできます。更新対象のデータがすべて更新された時点で、digest メソッドの 1 つを呼び出すことにより、ハッシュ計算を終了する必要があります。
digest メソッドは、指定回数の更新に対して 1 回呼び出すだけで済みます。digest メソッドの呼び出しが終了したあと、MessageDigest オブジェクトは初期化状態にリセットされます。
Cloneable インタフェースは、自由に実装できます。クライアントアプリケーションは、複製の生成を試行して CloneNotSupportedException をキャッチすれば、複製の生成が可能かどうかを調べることができます。
MessageDigest md = MessageDigest.getInstance("SHA");
try {
md.update(toChapter1);
MessageDigest tc1 = md.clone();
byte[] toChapter1Digest = tc1.digest();
md.update(toChapter2);
...etc.
} catch (CloneNotSupportedException cnse) {
throw new DigestException("couldn't make digest of partial content");
}
使用する実装例が複製可能でない場合でも、ダイジェストの数が前もってわかっているときには、いくつかのインスタンスを生成することによって、中間的なダイジェストを計算できます。
このクラスは、歴史的な事情から MessageDigestSpi クラスから拡張された abstract クラスになっていることに注意してください。アプリケーションの開発者は、MessageDigest クラスで定義されたメソッドだけに配慮してください。スーパークラスのすべてのメソッドは、メッセージダイジェストアルゴリズムの独自の実装を提供する必要がある暗号サービスプロバイダで使用されることを想定しています。
Java プラットフォームの実装は、すべて次の標準の MessageDigest アルゴリズムをサポートする必要があります。
| 修飾子 | コンストラクタと説明 |
|---|---|
protected |
MessageDigest(String algorithm)
指定されたアルゴリズム名を使用してメッセージダイジェストを作成します。
|
| 修飾子と型 | メソッドと説明 |
|---|---|
Object |
clone()
実装が複製可能な場合は複製を返します。
|
byte[] |
digest()
パディングなどの最終処理を行なってハッシュ計算を完了します。
|
byte[] |
digest(byte[] input)
指定されたバイト配列を使用してダイジェストに対して最終の更新を実行したあと、ダイジェスト計算を完了します。
|
int |
digest(byte[] buf, int offset, int len)
パディングなどの最終処理を行なってハッシュ計算を完了します。
|
String |
getAlgorithm()
実装の詳細に依存しないアルゴリズムを識別する文字列を返します。
|
int |
getDigestLength()
ダイジェストの長さをバイトで返します。この処理がプロバイダによってサポートされておらず、かつ実装が複製可能ではない場合は 0 を返します。
|
static MessageDigest |
getInstance(String algorithm)
指定されたダイジェストアルゴリズムを実装する MessageDigest オブジェクトを返します。
|
static MessageDigest |
getInstance(String algorithm, Provider provider)
指定されたダイジェストアルゴリズムを実装する MessageDigest オブジェクトを返します。
|
static MessageDigest |
getInstance(String algorithm, String provider)
指定されたダイジェストアルゴリズムを実装する MessageDigest オブジェクトを返します。
|
Provider |
getProvider()
このメッセージダイジェストオブジェクトのプロバイダを返します。
|
static boolean |
isEqual(byte[] digesta, byte[] digestb)
2 つのダイジェストが等しいかどうかを比較します。
|
void |
reset()
再利用のためにダイジェストをリセットします。
|
String |
toString()
このメッセージダイジェストオブジェクトの文字列表現を返します。
|
void |
update(byte input)
指定されたバイトデータを使ってダイジェストを更新します。
|
void |
update(byte[] input)
指定されたバイト配列を使用してダイジェストを更新します。
|
void |
update(byte[] input, int offset, int len)
指定されたバイトデータの配列を使って、指定されたオフセットから開始してダイジェストを更新します。
|
void |
update(ByteBuffer input)
指定された ByteBuffer を使用してダイジェストを更新します。
|
engineDigest, engineDigest, engineGetDigestLength, engineReset, engineUpdate, engineUpdate, engineUpdateprotected MessageDigest(String algorithm)
algorithm - ダイジェストアルゴリズムの標準名。アルゴリズムの標準名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの MessageDigest のセクションを参照。public static MessageDigest getInstance(String algorithm) throws NoSuchAlgorithmException
このメソッドは、最優先の Provider から順に、登録済みのセキュリティー Provider のリストをトラバースします。指定されたアルゴリズムをサポートする最初の Provider の MessageDigestSpi 実装をカプセル化する新しい MessageDigest オブジェクトが返されます。
登録済みプロバイダのリストは、Security.getProviders() メソッド経由で取得できます。
algorithm - 要求するアルゴリズムの名前。アルゴリズムの標準名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの MessageDigest のセクションを参照。NoSuchAlgorithmException - 指定したアルゴリズムの MessageDigestSpi 実装をサポートするプロバイダが存在しない場合。Providerpublic static MessageDigest getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
指定されたプロバイダの MessageDigestSpi 実装をカプセル化する新しい MessageDigest オブジェクトが返されます。指定したプロバイダは、セキュリティープロバイダリストに登録する必要があります。
登録済みプロバイダのリストは、Security.getProviders() メソッド経由で取得できます。
algorithm - 要求するアルゴリズムの名前。アルゴリズムの標準名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの MessageDigest のセクションを参照。provider - プロバイダ名。NoSuchAlgorithmException - 指定されたプロバイダに指定されたアルゴリズムの MessageDigestSpi 実装がない場合。NoSuchProviderException - 指定されたプロバイダがセキュリティープロバイダリストに登録されていない場合。IllegalArgumentException - プロバイダ名が null または空の場合。Providerpublic static MessageDigest getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
指定された Provider オブジェクトの MessageDigestSpi 実装をカプセル化する新しい MessageDigest オブジェクトが返されます。指定された Provider オブジェクトは、プロバイダリストに登録する必要はありません。
algorithm - 要求するアルゴリズムの名前。アルゴリズムの標準名については、Java 暗号化アーキテクチャー標準アルゴリズム名のドキュメントの MessageDigest のセクションを参照。provider - プロバイダ。NoSuchAlgorithmException - 指定された Provider オブジェクトに指定されたアルゴリズムの MessageDigestSpi の実装がない場合。IllegalArgumentException - 指定されたプロバイダが null の場合。Providerpublic final Provider getProvider()
public void update(byte input)
input - ダイジェストを更新するバイト。public void update(byte[] input,
int offset,
int len)
input - バイトの配列。offset - バイトの配列での開始オフセット。len - 使用するバイト数 (offset から開始)。public void update(byte[] input)
input - バイトの配列。public final void update(ByteBuffer input)
input.position() 位置から始まる input.remaining() バイトが使用されます。終了時に、バッファーの位置はリミットに等しくなりますが、リミットは変更されません。input - ByteBufferpublic byte[] digest()
public int digest(byte[] buf,
int offset,
int len)
throws DigestException
buf - 計算済みのダイジェストの出力先バッファーoffset - 出力バッファーにダイジェストの格納を開始する位置を示すオフセットlen - ダイジェストを割り当てるバッファーのバイト数buf に格納されたバイト数DigestException - エラーが発生した場合。public byte[] digest(byte[] input)
update(input) メソッドを呼び出して input 配列を update メソッドに渡したあと、digest() メソッドを呼び出します。input - ダイジェストの完了前に更新する対象の入力。public String toString()
public static boolean isEqual(byte[] digesta,
byte[] digestb)
digesta - 比較する一方のダイジェスト。digestb - 比較する他方のダイジェスト。public void reset()
public final String getAlgorithm()
public final int getDigestLength()
public Object clone() throws CloneNotSupportedException
clone、クラス: MessageDigestSpiCloneNotSupportedException - Cloneable をサポートしていない実装で呼び出された場合。Cloneable バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.