SHOW Signed

net.rim.device.api.crypto
Class SignatureSignerFactory

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

public abstract class SignatureSignerFactory

extends Object

Contains the functionality for a high level approach to signature signing.

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.

Constructor Summary

Method Summary

	static Enumeration	getAlgorithms() Returns an Enumeration of String representing all of the registered algorithms with this factory.
	static SignatureSigner	getInstance(PrivateKey key, String algorithm) Constructs and returns a new SignatureSigner.

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail

getInstance

public static SignatureSigner getInstance(PrivateKey key,
                                          String algorithm)
                                   throws NoSuchAlgorithmException,
                                          CryptoTokenException,
                                          CryptoUnsupportedOperationException

Constructs and returns a new SignatureSigner. A SignatureSignerFactory object is selected based on algorithm, or key.getAlgorithm.

The algorithm argument can be one of the following recognized strings representing the SignatureSigner to construct:

STRING	SIGNATURESIGNER
"DSA"	DSASignatureSigner
"ECDSA"	ECDSASignatureSigner
"ECNR"	ECNRSignatureSigner
"RSA_PKCS1"	PKCS1SignatureSigner (version 2.0)
"RSA_PKCS1_V20"	PKCS1SignatureSigner (version 2.0)
"RSA_PKCS1_V15"	PKCS1SignatureSigner (version 1.5)
"RSA_PSS"	PSSSignatureSigner
"RSA_X931"	X931SignatureSigner

NOTE: If the algorithm argument is null, than the type of signature signer to be constructed is defined from the PrivateKey argument. That is, DSA, ECDSA, and PKCS1 (version 2.0) are the default values returned for DSA, EC, and RSA PrivateKeys respectively. For example, if an ECNR signature signer is desired, the algorithm parameter must specify this, if null is used, an ECDSA signature signer will be created.

NOTE: If the parameter argument is null, than the default digest used in constructing a PKCS1V15 signature signer is an MD5 digest, for all other signature signers to be created, the default digest is SHA1.

Parameters:

key - The PrivateKey for signing

algorithm - The name of the SignatureSigner to construct. This parameter may be null.

Returns:

A SignatureSigner object.

Throws:

NoSuchAlgorithmException - Thrown if the specified algorithm does not exist.

CryptoTokenException - Thrown if an error occurs with a crypto token or the crypto token is invalid.

CryptoUnsupportedOperationException - Thrown if a call is made to an unsupported operation.

Since:

JDE 3.6

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.

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.

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.