SHOW Signed

net.rim.device.api.crypto
Class RC2Key

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

All Implemented Interfaces:

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

public final class RC2Key

extends Object

implements SymmetricKey, Persistable

Creates an RC2 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

	RC2Key() Create a new random 128 (actual/effective) bit key.
	RC2Key(byte[] data) Creates an RC2Key object using existing data.
	RC2Key(byte[] data, int effectiveBitLength) Creates a key using existing data and the specified effective bit length.
	RC2Key(byte[] data, int offset, int bitLength) Creates an RC2Key object using existing data.
	RC2Key(byte[] data, int offset, int bitLength, int effectiveBitLength) Creates an RC2Key object using existing data and the specified effective bit length.
	RC2Key(int bitLength) Creates a new random RC2Key object of the specified actual/effective bit length.
	RC2Key(int bitLength, int effectiveBitLength) Creates a new random RC2Key object based on the specified actual and effective bit lengths.

Method Summary

	static int	decodeEffectiveBitLength(int encodedEffectiveBitLength) Decodes an encoded effective bit length as specified in RFC 2268.
	static int	encodeEffectiveBitLength(int effectiveBitLength) Encodes an effective bit length as specified in RFC 2268.
	boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
	String	getAlgorithm() Returns a string containing the name of the algorithm associated with this key ("RC2").
	int	getBitLength() Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ).
	byte[]	getData() Returns a copy of the byte array representing the key.
	int	getEffectiveBitLength() Returns the effective bit length.
	int	getLength() Returns the length of the key in bytes.
	int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

RC2Key

public RC2Key()

Create a new random 128 (actual/effective) 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.

RC2Key

public RC2Key(int bitLength)

Creates a new random RC2Key object of the specified actual/effective bit length.

Parameters:

bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).

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.

RC2Key

public RC2Key(int bitLength,
              int effectiveBitLength)

Creates a new random RC2Key object based on the specified actual and effective bit lengths.

Parameters:

bitLength - The length of the key in bits (must be between 8 and 1024, and a multiple of 8).

effectiveBitLength - The effective length of the key in bits (must be between 1 and 1024).

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.

RC2Key

public RC2Key(byte[] data)

Creates an RC2Key object using existing data. The effective bit length will match the actual bit length.

Parameters:

data - A byte array containing the bytes to use as the key (data.length must be between 1 and 128).

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.

RC2Key

public RC2Key(byte[] data,
              int effectiveBitLength)

Creates a key using existing data and the specified effective bit length.

Parameters:

data - A byte array containing the bytes to use as the key (data.length must be between 1 and 128).

effectiveBitLength - The effective length of the key in bits (must be between 1 and 1024).

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.

RC2Key

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

Creates an RC2Key object using existing data. The effective bit length will match the actual bit length.

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 (must be between 8 and 1024, and a multiple of 8).

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.

RC2Key

public RC2Key(byte[] data,
              int offset,
              int bitLength,
              int effectiveBitLength)

Creates an RC2Key object using existing data and the specified effective bit length.

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 (must be between 8 and 1024, and a multiple of 8).

effectiveBitLength - The effective length of the key in bits (must be between 1 and 1024).

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.

Method Detail

getAlgorithm

public String getAlgorithm()

Returns a string containing the name of the algorithm associated with this key ("RC2").

This method will always return the String "RC2".

Specified by:

getAlgorithm in interface Key

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.

Specified by:

getLength in interface SymmetricKey

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

Specified by:

getBitLength in interface SymmetricKey

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.

Specified by:

getData in interface SymmetricKey

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.

getEffectiveBitLength

public int getEffectiveBitLength()
                          throws CryptoTokenException,
                                 CryptoUnsupportedOperationException

Returns the effective bit length.

Returns:

An integer that represents the effective bit length of the key.

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.

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

decodeEffectiveBitLength

public static int decodeEffectiveBitLength(int encodedEffectiveBitLength)

Decodes an encoded effective bit length as specified in RFC 2268.

Parameters:

encodedEffectiveBitLength - The encoded effective bit length to be decoded.

Returns:

The effective bit length.

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.

encodeEffectiveBitLength

public static int encodeEffectiveBitLength(int effectiveBitLength)

Encodes an effective bit length as specified in RFC 2268.

Parameters:

effectiveBitLength - The effective bit length to be encoded.

Returns:

The encoded effective bit length.

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.