SHOW Signed SHOW CryptoExtensionAPI

net.rim.device.api.crypto
Class RC5Key

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

All Implemented Interfaces:

Key, net.rim.vm.Persistable, Persistable, SymmetricKey

public final class RC5Key

extends Object

implements SymmetricKey, Persistable

Creates an RC5 key.

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

	RC5Key() Creates a new random 128 bit key.
	RC5Key(byte[] data) Creates an RC5Key object using existing data.
	RC5Key(byte[] data, int offset) Creates an RC5Key object using existing data.
	RC5Key(byte[] data, int offset, int bitLength) Creates an RC5Key object using existing data.
	RC5Key(int bitLength) Creates a new random key of the specified length.
	RC5Key(RC5CryptoToken cryptoToken, byte[] data, int offset, int bitLength) Creates an RC5Key object using existing data.
	RC5Key(RC5CryptoToken cryptoToken, CryptoTokenSymmetricKeyData cryptoTokenData) Creates an RC5Key object.

Method Summary

	boolean	equals(Object obj)
	String	getAlgorithm() Returns a String containing the name of the algorithm associated with this key ("RC5").
	int	getBitLength()
	CryptoTokenSymmetricKeyData	getCryptoTokenData() Returns the symmetric key data associated with the crypto token.
	byte[]	getData()
	int	getLength()
	RC5CryptoToken	getRC5CryptoToken() Returns the RC5CryptoToken object used to create the key.
	SymmetricCryptoToken	getSymmetricCryptoToken() Returns the crypto token associated with this key.
	int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RC5Key

public RC5Key()

Creates a new random 128 bit key.

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.

RC5Key

public RC5Key(int bitLength)

Creates a new random key of the specified length.

Parameters:

bitLength - The length of the key in bits (0 to 2040).

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.

RC5Key

public RC5Key(byte[] data)

Creates an RC5Key object using existing data.

Parameters:

data - A byte array containing the bytes to use as the key.

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.

RC5Key

public RC5Key(byte[] data,
              int offset)

Creates an RC5Key object using existing data. This call will try to create a 128 bit key if possible.

Parameters:

data - A byte array containing the bytes to use as the key.

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

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.

RC5Key

public RC5Key(byte[] data,
              int offset,
              int bitLength)

Creates an RC5Key object using existing data.

Parameters:

data - A byte array containing the bytes to use as the key.

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

bitLength - The length of the key in bits.

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.

RC5Key

public RC5Key(RC5CryptoToken cryptoToken,
              byte[] data,
              int offset,
              int bitLength)
       throws CryptoTokenException,
              CryptoUnsupportedOperationException

Creates an RC5Key object using existing data.

Parameters:

cryptoToken - The crypto token that protects the key.

data - A byte array containing the bytes to use as the key.

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

bitLength - The length of the key in bits.

Throws:

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

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

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

RC5Key

public RC5Key(RC5CryptoToken cryptoToken,
              CryptoTokenSymmetricKeyData cryptoTokenData)

Creates an RC5Key object.

Parameters:

cryptoToken - The crypto token used to create the key.

cryptoTokenData - The data associated with the crypto token.

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

Method Detail

getAlgorithm

public String getAlgorithm()

Returns a String containing the name of the algorithm associated with this key ("RC5").

This method will always return the String "RC5".

Returns:

A String that represents the name of the algorithm.

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.

getLength

public int getLength()
              throws CryptoTokenException,
                     CryptoUnsupportedOperationException

Description copied from interface: SymmetricKey

Returns the length of the key in bytes.

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.

getBitLength

public int getBitLength()
                 throws CryptoTokenException,
                        CryptoUnsupportedOperationException

Description copied from interface: SymmetricKey

Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ).

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.

getData

public byte[] getData()
               throws CryptoTokenException,
                      CryptoUnsupportedOperationException

Description copied from interface: SymmetricKey

Returns a copy of the byte array representing the key.

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.

getSymmetricCryptoToken

public SymmetricCryptoToken getSymmetricCryptoToken()

Returns the crypto token associated with this key.

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.

getRC5CryptoToken

public RC5CryptoToken getRC5CryptoToken()

Returns the RC5CryptoToken object used to create the key.

Returns:

The crypto token used to create the key.

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

getCryptoTokenData

public CryptoTokenSymmetricKeyData getCryptoTokenData()

Returns the symmetric key data associated with the crypto token.

Returns:

The CryptoTokenSymmetricKeyData object that contains the key data.

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

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

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.

equals

public boolean equals(Object obj)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

• It is reflexive: for any reference value x, x.equals(x) should return true.
• It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:

equals in class Object

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.