SHOW Signed

net.rim.device.api.crypto
Class MACInputStream

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

public class MACInputStream

extends CryptoInputStream

Provides streaming functionality with a MAC by allowing for read calls to an underlying input stream and passing this information through the MAC as it is being read.

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:

MACOutputStream

Field Summary

	protected MAC	_mac Stores that MAC for later use.
	protected boolean	_on A boolean that determines if information that is read from the input stream should be passed through the MAC before being returned to the user.

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

_inputStream

Constructor Summary

MACInputStream(MAC mac, InputStream inputStream) Creates a MACInputStream object with the specified MAC and an input stream that will contain the data to be read.

Method Summary

	String	getAlgorithm() Returns the name of this algorithm, eg "HMAC".
	MAC	getMAC() Returns a reference to the MAC being used in this instance of the class.
	void	on(boolean on) Allows the programmer to turn the MAC functionality of the stream on or off at will.
	int	read(byte[] data, int offset, int length) Reads up to the specified number of bytes from this input stream into an array of bytes.

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

_mac

protected MAC _mac

Stores that MAC 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 determines if information that is read from the input stream should be passed through the MAC before being returned to the user.

Note: 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

MACInputStream

public MACInputStream(MAC mac,
                      InputStream inputStream)

Creates a MACInputStream object with the specified MAC and an input stream that will contain the data to be read.

Parameters:

mac - The MAC object to use with this input stream.

inputStream - The underlying inputStream object that all data will be read 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 "HMAC".

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)

Allows the programmer to turn the MAC functionality of the stream on or off at will. The "on" boolean will determine whether information that is read will be passed through the MAC before being returned back to the user.

Note that _on is true by default.

Parameters:

on - A boolean stating whether the MAC is on (true) or off (false).

Since:

JDE 4.0.2

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[] data,
                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 4.0.2

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.

getMAC

public MAC getMAC()

Returns a reference to the MAC being used in this instance of the class.

Returns:

The current MAC object.

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.