- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- java.security.DigestInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class DigestInputStream extends FilterInputStream
A transparent stream that updates the associated message digest using the bits going through the stream.To complete the message digest computation, call one of the
digest
methods on the associated message digest after your calls to one of this digest input stream'sread
methods.It is possible to turn this stream on or off (see
on
). When it is on, a call to one of theread
methods results in an update on the message digest. But when it is off, the message digest is not updated. The default is for the stream to be on.Note that digest objects can compute only one digest (see
MessageDigest
), so that in order to compute intermediate digests, a caller should retain a handle onto the digest object, and clone it for each digest to be computed, leaving the orginal digest untouched.- See Also:
MessageDigest
,DigestOutputStream
-
-
Field Summary
Fields Modifier and Type Field and Description protected MessageDigest
digest
The message digest associated with this stream.-
Fields inherited from class java.io.FilterInputStream
in
-
-
Constructor Summary
Constructors Constructor and Description DigestInputStream(InputStream stream, MessageDigest digest)
Creates a digest input stream, using the specified input stream and message digest.
-
Method Summary
Methods Modifier and Type Method and Description MessageDigest
getMessageDigest()
Returns the message digest associated with this stream.void
on(boolean on)
Turns the digest function on or off.int
read()
Reads a byte, and updates the message digest (if the digest function is on).int
read(byte[] b, int off, int len)
Reads into a byte array, and updates the message digest (if the digest function is on).void
setMessageDigest(MessageDigest digest)
Associates the specified message digest with this stream.String
toString()
Prints a string representation of this digest input stream and its associated message digest object.
-
-
-
Field Detail
-
digest
protected MessageDigest digest
The message digest associated with this stream.
-
-
Constructor Detail
-
DigestInputStream
public DigestInputStream(InputStream stream, MessageDigest digest)
Creates a digest input stream, using the specified input stream and message digest.- Parameters:
stream
- the input stream.digest
- the message digest to associate with this stream.
-
-
Method Detail
-
getMessageDigest
public MessageDigest getMessageDigest()
Returns the message digest associated with this stream.- Returns:
- the message digest associated with this stream.
- See Also:
setMessageDigest(java.security.MessageDigest)
-
setMessageDigest
public void setMessageDigest(MessageDigest digest)
Associates the specified message digest with this stream.- Parameters:
digest
- the message digest to be associated with this stream.- See Also:
getMessageDigest()
-
read
public int read() throws IOException
Reads a byte, and updates the message digest (if the digest function is on). That is, this method reads a byte from the input stream, blocking until the byte is actually read. If the digest function is on (seeon
), this method will then callupdate
on the message digest associated with this stream, passing it the byte read.- Overrides:
read
in classFilterInputStream
- Returns:
- the byte read.
- Throws:
IOException
- if an I/O error occurs.- See Also:
MessageDigest.update(byte)
-
read
public int read(byte[] b, int off, int len) throws IOException
Reads into a byte array, and updates the message digest (if the digest function is on). That is, this method reads up tolen
bytes from the input stream into the arrayb
, starting at offsetoff
. This method blocks until the data is actually read. If the digest function is on (seeon
), this method will then callupdate
on the message digest associated with this stream, passing it the data.- Overrides:
read
in classFilterInputStream
- Parameters:
b
- the array into which the data is read.off
- the starting offset intob
of where the data should be placed.len
- the maximum number of bytes to be read from the input stream into b, starting at offsetoff
.- Returns:
- the actual number of bytes read. This is less than
len
if the end of the stream is reached prior to readinglen
bytes. -1 is returned if no bytes were read because the end of the stream had already been reached when the call was made. - Throws:
IOException
- if an I/O error occurs.- See Also:
MessageDigest.update(byte[], int, int)
-
on
public void on(boolean on)
Turns the digest function on or off. The default is on. When it is on, a call to one of theread
methods results in an update on the message digest. But when it is off, the message digest is not updated.- Parameters:
on
- true to turn the digest function on, false to turn it off.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/security/DigestInputStream.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.