net.rim.device.api.crypto
Class AbstractDigest

java.lang.Object
  extended by 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 applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

Constructor Summary
Category: Signed protected AbstractDigest()
          Creates a new AbstractDigest object.
 
Method Summary
Category: Signed abstract  String getAlgorithm()
          Returns the name of this digest, for example "SHA1".
Category: Signed  int getBlockLength()
          Returns the block length of the digest in bytes.
Category: Signed  byte[] getDigest()
          Returns a byte array containing the digest of all the input data since the last reset.
Category: Signed  byte[] getDigest(boolean resetDigest)
          Returns a byte array containing the digest of all the input data since the last reset.
Category: Signed  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.
Category: Signed 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.
Category: Signed abstract  int getDigestLength()
          Returns the length of the digest in bytes.
Category: Signed abstract  void reset()
          Reinitializes the digest.
Category: Signed  void update(byte[] data)
          Passes a byte array of data into the hash algorithm.
Category: Signed 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.
Category: Signed  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.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0


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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

reset

public abstract void reset()
Reinitializes the digest.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

update

public void update(int data)
Passes a single byte into the hash algorithm.

Parameters:
data - The byte to be hashed.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

getDigestLength

public abstract int getDigestLength()
Returns the length of the digest in bytes.

Returns:
An integer representing the number of bytes.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0

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.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 3.6.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.