net.rim.device.api.crypto.HMACKey
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public final class HMACKey
Creates an HMAC key. For information on cryptographic algorithms, see Crypto Algorithms.
| Constructor Summary | ||
|---|---|---|
|
HMACKey()
Creates a new random HMACKey object of size 128 bits. |
|
|
HMACKey(byte[] data)
Creates an HMACKey object using the provided data. |
|
|
HMACKey(byte[] data,
int offset,
int length)
Creates a key using the provided data. |
|
|
HMACKey(int length)
Creates a new random HMACKey object. |
|
|
HMACKey(HMACCryptoToken cryptoToken,
byte[] data,
int offset,
int length)
Creates a key using the provided data. |
|
|
HMACKey(HMACCryptoToken cryptoToken,
int length)
Creates a new random HMACKey object. |
|
|
HMACKey(HMACCryptoToken cryptoToken,
CryptoTokenMACKeyData cryptoTokenData)
Creates an HMACKey object using the specified crypto token
and crypto token data. |
|
| Method Summary | ||
|---|---|---|
|
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
|
String |
getAlgorithm()
Returns the name of the algorithm associated with this key ("HMAC"). |
|
int |
getBitLength()
Returns the number of bits that make up the actual keying material ( for example parity bits are not counted ). |
|
CryptoTokenMACKeyData |
getCryptoTokenData()
Returns the crypto token MAC key data used to create the key. |
|
byte[] |
getData()
Returns a copy of the byte array representing the key. |
|
HMACCryptoToken |
getHMACCryptoToken()
Returns the HMAC crypto token used to create the key. |
|
int |
getLength()
Returns the length of the key in bytes. |
|
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 HMACKey()
HMACKey object of size 128 bits.
public HMACKey(int length)
HMACKey object.
length - An integer that specifies the length of the HMAC key in bytes.
public HMACKey(HMACCryptoToken cryptoToken,
int length)
throws CryptoTokenException,
CryptoUnsupportedOperationException
HMACKey object.
cryptoToken - The token that protects the key.length - The length of the HMAC key in bytes.
CryptoTokenException - Thrown if an error occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to
an unsupported operation.public HMACKey(byte[] data)
HMACKey object using the provided data.
data - The key to use for the HMACKey.
public HMACKey(byte[] data,
int offset,
int length)
data - A byte array containing the key to use for the HMACKey.offset - The offset, or starting position, of the data withiin the array.length - Determines how many bytes to read from data.
public HMACKey(HMACCryptoToken cryptoToken,
byte[] data,
int offset,
int length)
throws CryptoTokenException,
CryptoUnsupportedOperationException
cryptoToken - The token that protects the key.data - A byte array containing the key to use for the HMACKey.offset - The offset, or start position, of the data within the array.length - The length, or number of bytes, to read from data.
CryptoTokenException - Thrown if an error occurs with a crypto
token or the crypto token is invalid.
CryptoUnsupportedOperationException - Thrown if a call is made to
an unsupported operation.
public HMACKey(HMACCryptoToken cryptoToken,
CryptoTokenMACKeyData cryptoTokenData)
HMACKey object using the specified crypto token
and crypto token data.
cryptoToken - The crypto tokne used to create the key.cryptoTokenData - The associated crypto token data.| Method Detail |
|---|
public String getAlgorithm()
This method will always return the String "HMAC".
getAlgorithm in interface Key
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 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 SymmetricCryptoToken getSymmetricCryptoToken()
getSymmetricCryptoToken in interface SymmetricKeypublic HMACCryptoToken getHMACCryptoToken()
HMACCryptoToken object used to create the key.public CryptoTokenMACKeyData getCryptoTokenData()
CryptoTokenMACKeyData object used to create the key.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