SHOW Signed

net.rim.device.api.crypto
Class MACFactory

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

public abstract class MACFactory

extends Object

Creates a Message Authentication Code MAC using the specified parameters.

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:

MAC, SymmetricKeyFactory

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail

getInstance

public static MAC getInstance(SymmetricKey key)
                       throws NoSuchAlgorithmException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException

Constructs and returns a new MAC. A MACFactory object is selected based on key.getAlgorithm(), eg an HMAC key will return an HMAC object, and a DES key will return a CBCMAC object.

Parameters:

key - The key used to extract the key data from.

Returns:

The MAC.

Throws:

NoSuchAlgorithmException - Thrown if the MAC cannot be constructed.

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

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

Since:

JDE 4.0.2

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 MAC getInstance(String algorithm,
                              SymmetricKey key)
                       throws NoSuchAlgorithmException,
                              CryptoTokenException,
                              CryptoUnsupportedOperationException

Constructs and returns a new MAC.

A MACFactory object is selected based on the String alone. The keydata will simply be extracted from the symmetric key.

Parameters:

algorithm - A String containing the specified MAC algorithm. e.g. "HMAC/SHA1", "CBCMAC/DES"

key - The key used to extract key data from.

Returns:

The MAC.

Throws:

NoSuchAlgorithmException - Thrown if the MAC cannot be constructed.

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

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

Since:

JDE 4.0.2

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.