java.security

クラス DigestOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.security.DigestOutputStream

すべての実装されたインタフェース:

Closeable、Flushable、AutoCloseable

public class DigestOutputStream
extends FilterOutputStream

ストリームを通過するビットを使用して、関連したメッセージダイジェストを更新する透明なストリームです。

メッセージダイジェストの計算を完了するには、このダイジェスト出力ストリームの write メソッドの 1 つを呼び出したあと、関連したメッセージダイジェストに対して digest メソッドの 1 つを呼び出します。

このストリームをオンまたはオフにすることができます (on を参照)。オンの場合、write メソッドの 1 つに対する呼び出しは、メッセージダイジェストを更新します。ただし、オフの場合にはメッセージダイジェストは更新されません。ストリームに対するデフォルトはオンです。

関連項目:

MessageDigest, DigestInputStream

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected MessageDigest	digest このストリームに関連したメッセージダイジェストです。

クラス java.io.FilterOutputStream から継承されたフィールド

out

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
DigestOutputStream(OutputStream stream, MessageDigest digest) 指定された出力ストリームとメッセージダイジェストを使用して、ダイジェストを出力するストリームを作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
MessageDigest	getMessageDigest() このストリームに関連したメッセージダイジェストを返します。
void	on(boolean on) ダイジェスト機能をオンまたはオフにします。
void	setMessageDigest(MessageDigest digest) 指定されたメッセージダイジェストをこのストリームに関連付けます。
String	toString() このダイジェスト出力ストリームとそれに関連したメッセージダイジェストオブジェクトの文字列表現を出力します。
void	write(byte[] b, int off, int len) ダイジェスト機能がオンの場合に指定された部分配列を使用して、メッセージダイジェストを更新し、どのような場合でもその部分配列を出力ストリームに書き込みます。
void	write(int b) 指定されたバイトを使用して (ダイジェスト機能がオンの場合に) メッセージダイジェストを更新し、どのような場合でもそのバイトを出力ストリームに書き込みます。

クラス java.io.FilterOutputStream から継承されたメソッド

close, flush, write

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

digest

protected MessageDigest digest

このストリームに関連したメッセージダイジェストです。

コンストラクタの詳細

DigestOutputStream

public DigestOutputStream(OutputStream stream,
                  MessageDigest digest)

指定された出力ストリームとメッセージダイジェストを使用して、ダイジェストを出力するストリームを作成します。

パラメータ:

stream - 出力ストリーム。

digest - このストリームに関連させるメッセージダイジェスト。

メソッドの詳細

getMessageDigest

public MessageDigest getMessageDigest()

このストリームに関連したメッセージダイジェストを返します。

戻り値:

このストリームに関連したメッセージダイジェスト。

関連項目:

setMessageDigest(java.security.MessageDigest)

setMessageDigest

public void setMessageDigest(MessageDigest digest)

指定されたメッセージダイジェストをこのストリームに関連付けます。

パラメータ:

digest - このストリームに関連したメッセージダイジェスト。

関連項目:

getMessageDigest()

write

public void write(int b)
           throws IOException

指定されたバイトを使用して (ダイジェスト機能がオンの場合に) メッセージダイジェストを更新し、どのような場合でもそのバイトを出力ストリームに書き込みます。すなわち、ダイジェスト機能がオン (on を参照) の場合には、このメソッドは、そのストリームに関連したメッセージダイジェストに対して update を呼び出し、バイト b を渡します。メソッドはその後、そのバイトを出力ストリームに書き込み、そのバイトの書き込みが完了するまで次の書き込みを行わせません。

オーバーライド:

write、クラス: FilterOutputStream

パラメータ:

b - 出力ストリームの更新および出力ストリームへの書き込みに使用するバイト。

例外:

IOException - 入出力エラーが発生した場合。

関連項目:

MessageDigest.update(byte)

write

public void write(byte[] b,
         int off,
         int len)
           throws IOException

ダイジェスト機能がオンの場合に指定された部分配列を使用して、メッセージダイジェストを更新し、どのような場合でもその部分配列を出力ストリームに書き込みます。すなわち、ダイジェスト機能がオン (on を参照) の場合には、このメソッドは、そのストリームに関連したメッセージダイジェストに対して update を呼び出し、指定された部分配列を渡します。メソッドはその後、部分配列のバイト群を出力ストリームに書き込み、そのバイト群の書き込みが完了するまで次の書き込みを行わせません。

オーバーライド:

write、クラス: FilterOutputStream

パラメータ:

b - 出力ストリームの更新および出力ストリームへの書き込みに使用する部分配列を含む配列。

off - b 内の、更新および書き込みを行う先頭バイトのオフセット。

len - オフセット off から開始して、b から更新および書き込みを行うデータのバイト数。

例外:

IOException - 入出力エラーが発生した場合。

関連項目:

MessageDigest.update(byte[], int, int)

on

public void on(boolean on)

ダイジェスト機能をオンまたはオフにします。デフォルトはオンです。オンの場合、write メソッドの 1 つに対する呼び出しは、メッセージダイジェストを更新します。ただし、オフの場合にはメッセージダイジェストは更新されません。

パラメータ:

on - ダイジェスト機能をオンにする場合は true、オフにする場合は false。

toString

public String toString()

このダイジェスト出力ストリームとそれに関連したメッセージダイジェストオブジェクトの文字列表現を出力します。

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現。