SHOW Signed

net.rim.device.api.crypto
Class DigestInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--net.rim.device.api.crypto.CryptoInputStream
              |
              +--net.rim.device.api.crypto.DigestInputStream

public class DigestInputStream

extends CryptoInputStream

Allows for a user to open an input stream and run a digest on all information that passes through that input stream.

This is incredibly useful when a hash is required on a data stream from another program or even another class.

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 3.6.0

See Also:

DigestOutputStream

Field Summary

	protected Digest	_digest A protected variable used to store the digest used with this instance of the class for later use.
	protected boolean	_on A boolean that enables the user to turn the digest part of the input stream on or off at their will.

Fields inherited from class net.rim.device.api.crypto.CryptoInputStream

_inputStream

Constructor Summary

DigestInputStream(Digest digest, InputStream inputStream) Creates a DigestInputStream object from a digest and an underlying input stream.

Method Summary

	String	getAlgorithm() Returns the name of this algorithm, eg "SHA1".
	Digest	getDigest() Returns a reference to the digest being used with this digest input stream.
	void	on(boolean on) Enables the user to turn on whether or not they want the data being read to go through the digest function as well.
	int	read(byte[] buffer, int offset, int length)

Methods inherited from class net.rim.device.api.crypto.CryptoInputStream

available, close, getInputStream, markSupported, read, read

Methods inherited from class java.io.InputStream

mark, reset, skip

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_digest

protected Digest _digest

A protected variable used to store the digest used with this instance of the class for later use.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

_on

protected boolean _on

A boolean that enables the user to turn the digest part of the input stream on or off at their will.

By default, _on is set to true.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Constructor Detail

DigestInputStream

public DigestInputStream(Digest digest,
                         InputStream inputStream)

Creates a DigestInputStream object from a digest and an underlying input stream.

Parameters:

digest - The digest that will be used for hashing all of the data read from the stream.

inputStream - The input stream that will be used to read the data from.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of this algorithm, eg "SHA1".

Overrides:

getAlgorithm in class CryptoInputStream

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

on

public void on(boolean on)

Enables the user to turn on whether or not they want the data being read to go through the digest function as well.

Note that _on is true by default.

Parameters:

on - When true, tells the program to pass the data read through the digest as well. If false, then this data is not passed through the digest but simply returned to the user.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws IOException

Description copied from class: CryptoInputStream

Reads up to the specified number of bytes from this input stream into an array of bytes. This method blocks until some input is available.

Overrides:

read in class CryptoInputStream

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getDigest

public Digest getDigest()

Returns a reference to the digest being used with this digest input stream.

Returns:

The digest.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.