net.rim.device.api.crypto
Class InitializationVectorFactory

java.lang.Object
  net.rim.device.api.crypto.InitializationVectorFactory

public class InitializationVectorFactory
extends Object

Contains the functionality for a high level approach to creating InitializationVectors.

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

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 Summary
	static Enumeration	getAlgorithms() Returns an Enumeration of String representing all of the registered algorithms with this factory.
	static InitializationVector	getInstance(String algorithm) Constructs and returns a new random InitializationVector object.
	static InitializationVector	getInstance(String algorithm, byte[] data, int offset) Constructs and returns a new InitializationVector object.
	static InitializationVector	getInstance(String algorithm, byte[] data, int offset, int maxLength) Constructs and returns a new InitializationVector object.
	static void	register(String algorithm, int defaultLength) Registers the given InitializationVectorFactory.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

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

Constructs and returns a new InitializationVector object.

The default length is used if algorithm does not specify a block length.

Parameters:

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

data - The iv data.

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

maxLength - The maximum length, in bytes, of the data available to the iv. Not all of the data may be required depending on the algorithm.

Returns:

An InitializationVector object.

Throws:

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

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

getInstance

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

Constructs and returns a new InitializationVector object.

A InitializationVector object is selected based on algorithm.

Parameters:

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

data - The iv data.

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

Returns:

A InitializationVector object.

Throws:

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

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

getInstance

public static InitializationVector getInstance(String algorithm)
                                        throws NoSuchAlgorithmException

Constructs and returns a new random InitializationVector object.

A InitializationVector is selected based on the algorithm.

Parameters:

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

Returns:

A InitializationVector object.

Throws:

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

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.7.0

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 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.7.0

register

public static void register(String algorithm,
                            int defaultLength)

Registers the given InitializationVectorFactory.

If a previous call registered a default value for the length of the Initialization Vector then you cannot overwrite it.

Parameters:

algorithm - the algorithm that one is specifying the default length for.

defaultLength - the default bit length of the algorithm.

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