Класс DigestInputStream

public class DigestInputStream
extends FilterInputStream

Прозрачный поток, который обновляет связанный дайджест сообщения с использованием бит, проходящих через поток.

Для завершения вычисления дайджеста сообщения вызовите один из digest методов связанного дайджеста сообщения после вызовов одного из методов потока дайджеста read.

Этот поток можно включить или выключить (см. on). Когда он включен, вызов одного из read методов приводит к обновлению дайджеста сообщения. Но когда он выключен, дайджест сообщения не обновляется. По умолчанию поток включен.

Обратите внимание, что объекты дайджестов могут вычислять только один дайджест (см. MessageDigest), поэтому для вычисления промежуточных дайджестов вызывающая сторона должна сохранить ссылку на объект дайджеста и клонировать его для каждого вычисляемого дайджеста, оставив исходный дайджест неизменным.

Подробное описание полей

digest

protected MessageDigest digest

Дайджест сообщения, связанный с этим потоком.

Подробное описание конструкторов

DigestInputStream

public DigestInputStream(InputStream stream,
                         MessageDigest digest)

Создает поток дайджеста, используя указанный поток и дайджест сообщения.

Параметры:

stream - поток.

digest - дайджест сообщения, который нужно связать с этим потоком.

Подробное описание методов

getMessageDigest

public MessageDigest getMessageDigest()

Возвращает дайджест сообщения, связанный с этим потоком.

Возвращает:

дайджест сообщения, связанный с этим потоком.

См. также:

setMessageDigest(java.security.MessageDigest)

setMessageDigest

public void setMessageDigest(MessageDigest digest)

Связывает указанный дайджест сообщения с этим потоком.

Параметры:

digest - дайджест сообщения, который нужно связать с этим потоком.

См. также:

getMessageDigest()

read

public int read()
         throws IOException

Считывает байт и обновляет дайджест сообщения (если функция дайджеста включена). То есть этот метод считывает байт из потока ввода, блокируя до тех пор, пока байт не будет фактически прочитан. Если функция дайджеста включена (см. on), этот метод затем вызовет update для дайджеста сообщения, связанного с этим потоком, передав ему прочитанный байт.

Переопределяет:

read в классе FilterInputStream

Возвращает:

прочитанный байт.

Исключения:

IOException - если произошла ошибка ввода-вывода.

См. также:

MessageDigest.update(byte)

read

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

Считывает в массив байтов и обновляет дайджест сообщения (если функция дайджеста включена). То есть этот метод считывает до len байтов из потока ввода в массив b, начиная с смещения off. Этот метод блокируется до тех пор, пока данные не будут фактически прочитаны. Если функция дайджеста включена (см. on), этот метод затем вызовет update для дайджеста сообщения, связанного с этим потоком, передав ему данные.

Переопределяет:

read в классе FilterInputStream

Параметры:

b - массив, в который считываются данные.

off - начальное смещение в b, где должны быть размещены данные.

len - максимальное количество байтов, которое должно быть считано из потока ввода в b, начиная со смещения off.

Возвращает:

фактическое количество прочитанных байтов. Это меньше len, если конец потока достигается до чтения len байтов. -1 возвращается, если байты не были прочитаны, потому что конец потока уже был достигнут при вызове.

Исключения:

IOException - если произошла ошибка ввода-вывода.

См. также:

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

on

public void on(boolean on)

Включает или выключает функцию дайджеста. По умолчанию включена. Когда она включена, вызов одного из read методов приводит к обновлению дайджеста сообщения. Но когда она выключена, дайджест сообщения не обновляется.

Параметры:

on - true для включения функции дайджеста, false для выключения.

toString

public String toString()

Выводит строковое представление этого потока дайджеста и связанного с ним объекта дайджеста сообщения.

Переопределяет:

toString в классе Object

Возвращает:

строковое представление объекта.