SHOW Signed SHOW CryptoExtensionAPI

net.rim.device.api.crypto
Class DigestFactory

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

public abstract class DigestFactory
extends Object

Creates a digest.

For more information on the cryptographic algorithms supported by this factory, see Crypto Algorithms.

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:
DigestInputStream, DigestOutputStream

Constructor Summary
 Category: CryptoExtensionAPI Category: Signed protected DigestFactory()
          Creates a DigestFactory object.
 
Method Summary
 Category: CryptoExtensionAPI Category: Signed protected abstract  Digest create(String algorithm)
          Called to create the Digest.
 Category: Signed static Enumeration getAlgorithms()
          Returns an Enumeration of String representing all of the registered algorithms with this factory.
 Category: CryptoExtensionAPI Category: Signed protected abstract  String[] getFactoryAlgorithms()
          Called to determine what algorithms are supported.
 Category: Signed static Digest getInstance(String algorithm)
          Constructs and returns a new Digest object.
 Category: CryptoExtensionAPI Category: Signed static void register(DigestFactory factory)
          Registers the given Digest object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DigestFactory

protected DigestFactory()
Creates a DigestFactory object.

This is the default constructor and is not used.

Since:
JDE 3.6.0
Category:
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.
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

create

protected abstract Digest create(String algorithm)
                          throws NoSuchAlgorithmException
Called to create the Digest.

Parameters:
algorithm - The algorithm used to create the digest.
Returns:
The Digest.
Throws:
NoSuchAlgorithmException - Thrown if the specified algorithm was not valid.
Since:
JDE 3.6.0
Category:
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.
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.

getAlgorithms

public static Enumeration getAlgorithms()
Returns an Enumeration of String representing all of the registered algorithms with this factory.
Returns:
An Enumeration of Strings representing all of the registered algorithms with this factory.
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.

getFactoryAlgorithms

protected abstract String[] getFactoryAlgorithms()
Called to determine what algorithms are supported.

Returns:
A String array representing the names of the algorithms.
Since:
JDE 3.6.0
Category:
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.
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.

getInstance

public static Digest getInstance(String algorithm)
                          throws NoSuchAlgorithmException
Constructs and returns a new Digest object.

Parameters:
algorithm - The name of the digest to construct, eg "SHA1", "MD5", etc.
Returns:
The Digest.
Throws:
NoSuchAlgorithmException - Thrown if the digest cannot be constructed.
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.

register

public static void register(DigestFactory factory)
Registers the given Digest object.

If a previous call registered a Digest with the same algorithm name, then the new one will be ignored.

Parameters:
factory - The digest factory to be registered.
Since:
JDE 3.6.0
Category:
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.
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.


Copyright 1999-2007 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.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.