net.rim.device.api.crypto.RC5Key
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public final class RC5Key
Creates an RC5 key.
For information on cryptographic algorithms, see Crypto Algorithms.
| 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)
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 ("RC5"). |
|
int |
getBitLength()
Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ). |
|
CryptoTokenSymmetricKeyData |
getCryptoTokenData()
Returns the symmetric key data associated with the crypto token. |
|
byte[] |
getData()
Returns a copy of the byte array representing the key. |
|
int |
getLength()
Returns the length of the key in bytes. |
|
RC5CryptoToken |
getRC5CryptoToken()
Returns the RC5CryptoToken object used to create the key. |
|
SymmetricCryptoToken |
getSymmetricCryptoToken()
Returns the crypto token associated with this key. |
|
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 |
|---|
public RC5Key()
public RC5Key(int bitLength)
bitLength - The length of the key in bits (0 to 2040).public RC5Key(byte[] data)
RC5Key object using existing data.
data - A byte array containing the bytes to use as the key.
public RC5Key(byte[] data,
int offset)
RC5Key object using existing data. This call will try to create a 128 bit key if possible.
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.
public RC5Key(byte[] data,
int offset,
int bitLength)
RC5Key object using existing data.
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.
public RC5Key(RC5CryptoToken cryptoToken,
byte[] data,
int offset,
int bitLength)
throws CryptoTokenException,
CryptoUnsupportedOperationException
RC5Key object using existing data.
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.
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.
public RC5Key(RC5CryptoToken cryptoToken,
CryptoTokenSymmetricKeyData cryptoTokenData)
RC5Key object.
cryptoToken - The crypto token used to create the key.cryptoTokenData - The data associated with the crypto token.| Method Detail |
|---|
public String getAlgorithm()
This method will always return the String "RC5".
getAlgorithm in interface Key
public int getLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getLength in interface SymmetricKeyCryptoTokenException - Thrown when a problem occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to an
unsupported operation.
public int getBitLength()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getBitLength in interface SymmetricKeyCryptoTokenException - Thrown when a problem occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to an
unsupported operation.
public byte[] getData()
throws CryptoTokenException,
CryptoUnsupportedOperationException
SymmetricKey
getData in interface SymmetricKeyCryptoTokenException - Thrown when a problem occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown when a call is made to
an unsupported operation.public SymmetricCryptoToken getSymmetricCryptoToken()
getSymmetricCryptoToken in interface SymmetricKeypublic RC5CryptoToken getRC5CryptoToken()
RC5CryptoToken object used to create the key.
public CryptoTokenSymmetricKeyData getCryptoTokenData()
Returns the symmetric key data associated with the crypto token.
CryptoTokenSymmetricKeyData object that
contains the key data.public int hashCode()
Objectjava.util.Hashtable.
The general contract of hashCode is:
hashCode method on each of
the two objects must produce the same integer result.
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 JavaTM programming language.)
hashCode in class ObjectObject.equals(java.lang.Object),
Hashtablepublic boolean equals(Object obj)
Object
The equals method implements an equivalence relation:
x,
x.equals(x) should return true.
x and
y, x.equals(y) should return
true if and only if y.equals(x) returns
true.
x,
y, and z, if x.equals(y)
returns true and y.equals(z) returns
true, then x.equals(z) should return
true.
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.
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).
equals in class Objectobj - the reference object with which to compare.
true if this object is the same as the obj
argument; false otherwise.Boolean.hashCode(),
Hashtable
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal