SHOW Signed

net.rim.device.api.crypto
Class SymmetricKeyFactory

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

public abstract class SymmetricKeyFactory

extends Object

Contains the functionality for a high level approach to creating symmetric keys.

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

Constructor Summary

Method Summary

	static Enumeration	getAlgorithms() Returns an Enumeration of String representing all of the registered algorithms with this factory.
	static SymmetricKey	getInstance(String algorithm) Constructs and returns a new random SymmetricKey object.
	static SymmetricKey	getInstance(String algorithm, byte[] data, int offset) Constructs and returns a new SymmetricKey object.
	static SymmetricKey	getInstance(String algorithm, byte[] data, int offset, int length) Constructs and returns a new SymmetricKey object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail

getInstance

public static SymmetricKey getInstance(String algorithm,
                                       byte[] data,
                                       int offset,
                                       int length)
                                throws NoSuchAlgorithmException

Constructs and returns a new SymmetricKey object.

A SymmetricKeyFactory object is selected based on algorithm. In case of a conflict between keylength passed into the method and that indicated by algorithm, the length indicated in the string is used.

Parameters:

algorithm - The name of the SymmetricKey to construct, eg "DES", "TripleDES".

data - The key data.

offset - The start, or initial position, of the key data within the array.

length - The length, in bytes, of the amount of key material available to the SymmetricKey.

Returns:

A SymmetricKey object.

Throws:

NoSuchAlgorithmException - Thrown if the SymmetricKey cannot be constructed or the specified algorithm is invalid.

Since:

JDE 3.7.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.

getInstance

public static SymmetricKey getInstance(String algorithm,
                                       byte[] data,
                                       int offset)
                                throws NoSuchAlgorithmException

Constructs and returns a new SymmetricKey object.

A SymmetricKeyFactory object is selected based on algorithm.

Parameters:

algorithm - The name of the SymmetricKey to construct, eg "DES", "TripleDES".

data - The key data.

offset - The start, or initial position, of the key data within the array.

Returns:

A SymmetricKey object.

Throws:

NoSuchAlgorithmException - Thrown if the SymmetricKey cannot be constructed or the specified algorithm is invalid.

Since:

JDE 3.7.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.

getInstance

public static SymmetricKey getInstance(String algorithm)
                                throws NoSuchAlgorithmException

Constructs and returns a new random SymmetricKey object.

A SymmetricKeyFactory object is selected based on algorithm.

Parameters:

algorithm - The name of the SymmetricKey to construct, eg "DES", "TripleDES".

Returns:

A random SymmetricKey object.

Throws:

NoSuchAlgorithmException - Thrown if the SymmetricKey cannot be constructed or the specified algorithm is invalid.

Since:

JDE 3.7.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.

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.