SHOW Signed SHOW CryptoExtensionAPI

net.rim.device.api.crypto
Class AbstractDigest

java.lang.Object
  |
  +--net.rim.device.api.crypto.AbstractDigest

Direct Known Subclasses:

MD2Digest, MD4Digest, MD5Digest, NullDigest, RIPEMD128Digest, RIPEMD160Digest, SHA1Digest, SHA224Digest, SHA256Digest, SHA384Digest, SHA512Digest

public abstract class AbstractDigest

extends Object

Implements the helper methods of the Digest interface.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

Since:

JDE 3.6.0

Constructor Summary

protected

AbstractDigest() Creates a new AbstractDigest object.

Method Summary

	abstract String	getAlgorithm() Returns the name of this digest, for example "SHA1".
	int	getBlockLength() Returns the block length of the digest in bytes.
	byte[]	getDigest() Returns a byte array containing the digest of all the input data since the last reset.
	byte[]	getDigest(boolean resetDigest) Returns a byte array containing the digest of all the input data since the last reset.
	int	getDigest(byte[] buffer, int offset) Inserts the digest of all the input data since the last reset into the specified buffer at the given offset.
	abstract int	getDigest(byte[] buffer, int offset, boolean resetDigest) Inserts the digest of all the input data since the last reset into the specified buffer at the given offset.
	abstract int	getDigestLength() Returns the length of the digest in bytes.
	abstract void	reset() Reinitializes the digest.
	void	update(byte[] data) Passes a byte array of data into the hash algorithm.
	abstract void	update(byte[] data, int offset, int length) Passes a byte array of data, specified by the length and offset, into the hash algorithm.
	void	update(int data) Passes a single byte into the hash algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDigest

protected AbstractDigest()

Creates a new AbstractDigest object.

This constructor does nothing.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

Method Detail

getAlgorithm

public abstract String getAlgorithm()

Returns the name of this digest, for example "SHA1".

Returns:

A String representing the name of 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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

reset

public abstract void reset()

Reinitializes 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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

update

public void update(int data)

Passes a single byte into the hash algorithm.

Parameters:

data - The byte to be hashed.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

update

public void update(byte[] data)

Passes a byte array of data into the hash algorithm.

Parameters:

data - The array containing the input data. The entire array is hashed.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

update

public abstract void update(byte[] data,
                            int offset,
                            int length)

Passes a byte array of data, specified by the length and offset, into the hash algorithm.

Parameters:

data - The array containing the input data.

offset - The offset of the input data.

length - The length of the input data.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getDigestLength

public abstract int getDigestLength()

Returns the length of the digest in bytes.

Returns:

An integer representing the number of bytes.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getBlockLength

public int getBlockLength()

Returns the block length of the digest in bytes. This block length is used in HMAC and therefore is overidden by HMAC-supported digests.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getDigest

public byte[] getDigest()

Returns a byte array containing the digest of all the input data since the last reset. The digest is then reset.

Returns:

A byte array containing 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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getDigest

public byte[] getDigest(boolean resetDigest)

Returns a byte array containing the digest of all the input data since the last reset.

Parameters:

resetDigest - if true, then the digest is reset.

Returns:

A byte array containing 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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getDigest

public int getDigest(byte[] buffer,
                     int offset)

Inserts the digest of all the input data since the last reset into the specified buffer at the given offset. The digest is then reset.

Parameters:

buffer - The byte array to hold the digest data.

offset - The offset, or initial bit position, to store the data at within the array.

Returns:

An integer representing the number of bytes written to the buffer.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.

getDigest

public abstract int getDigest(byte[] buffer,
                              int offset,
                              boolean resetDigest)

Inserts the digest of all the input data since the last reset into the specified buffer at the given offset.

Parameters:

buffer - The byte array to hold the digest data.

offset - The offset, or initial bit position, to store the data at within the array.

resetDigest - if true, then the digest is reset.

Returns:

An integer representing the number of bytes written to the buffer.

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.
CryptoExtensionAPI: This element is part of the Crypto Extension API. These APIs are intended for parties interested in extending the security provider frameworks, such as integrating a new security medium.