java.security.DigestOutputStream Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.security;
import java.io.IOException;
import java.io.EOFException;
import java.io.OutputStream;
import java.io.FilterOutputStream;
import java.io.PrintStream;
import java.io.ByteArrayOutputStream;
/**
* 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 ouput stream's
* {@link #write(int) write} methods.
*
*
It is possible to turn this stream on or off (see
* {@link #on(boolean) on}). When it is on, a call to one of the
* write 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.
*
* @see MessageDigest
* @see DigestInputStream
*
* @version 1.28 00/02/02
* @author Benjamin Renaud
*/
public class DigestOutputStream extends FilterOutputStream
{
/**
* The message digest associated with this stream.
*/
protected MessageDigest digest;
/**
* Creates a digest output stream, using the specified output stream
* and message digest.
*
* @param stream the output stream.
*
* @param digest the message digest to associate with this stream.
*/
public DigestOutputStream(OutputStream stream, MessageDigest digest) {
super(stream);
}
/**
* Returns the message digest associated with this stream.
*
* @return the message digest associated with this stream.
* @see #setMessageDigest(java.security.MessageDigest)
*/
public MessageDigest getMessageDigest() {
return null;
}
/**
* Associates the specified message digest with this stream.
*
* @param digest the message digest to be associated with this stream.
* @see #getMessageDigest()
*/
public void setMessageDigest(MessageDigest digest) { }
/**
* Updates the message digest (if the digest function is on) using
* the specified byte, and in any case writes the byte
* to the output stream. That is, if the digest function is on
* (see {@link #on(boolean) on}), this method calls
* update on the message digest associated with this
* stream, passing it the byte b. This method then
* writes the byte to the output stream, blocking until the byte
* is actually written.
*
* @param b the byte to be used for updating and writing to the
* output stream.
*
* @exception IOException if an I/O error occurs.
*
* @see MessageDigest#update(byte)
*/
public void write(int b) throws IOException { }
/**
* Updates the message digest (if the digest function is on) using
* the specified subarray, and in any case writes the subarray to
* the output stream. That is, if the digest function is on (see
* {@link #on(boolean) on}), this method calls update
* on the message digest associated with this stream, passing it
* the subarray specifications. This method then writes the subarray
* bytes to the output stream, blocking until the bytes are actually
* written.
*
* @param b the array containing the subarray to be used for updating
* and writing to the output stream.
*
* @param off the offset into b of the first byte to
* be updated and written.
*
* @param len the number of bytes of data to be updated and written
* from b, starting at offset off.
*
* @exception IOException if an I/O error occurs.
*
* @see MessageDigest#update(byte[], int, int)
*/
public void write(byte[] b, int off, int len) throws IOException { }
/**
* Turns the digest function on or off. The default is on. When
* it is on, a call to one of the write methods results in an
* update on the message digest. But when it is off, the message
* digest is not updated.
*
* @param on true to turn the digest function on, false to turn it
* off.
*/
public void on(boolean on) { }
/**
* Prints a string representation of this digest output stream and
* its associated message digest object.
*/
public String toString() {
return null;
}
}