Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> crypto >> [ spec overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.crypto.spec
Class SecretKeySpec  

java.lang.Object
  javax.crypto.spec.SecretKeySpec

All Implemented Interfaces:

java.security.Key, java.security.spec.KeySpec, javax.crypto.SecretKey, java.io.Serializable

---

public class SecretKeySpec

extends java.lang.Object

implements java.security.spec.KeySpec, javax.crypto.SecretKey

This is a simple wrapper around a raw byte array, for ciphers that do not require any key parameters other than the bytes themselves.

Since this class implements javax.crypto.SecretKey, which in turn extends java.security.Key, so instances of this class may be passed directly to the init() methods of javax.crypto.Cipher.

---

Field Summary
private  java.lang.String	algorithm           The algorithm's name.
private  byte[]	key           The key bytes.
private static long	serialVersionUID           Compatible with JDK1.4.

 

Constructor Summary

SecretKeySpec(byte[] key, int off, int len, java.lang.String algorithm)           Create a new secret key spec from part of a byte array.

SecretKeySpec(byte[] key, java.lang.String algorithm)           Create a new secret key spec from an entire byte array.

 

Method Summary
boolean	equals(java.lang.Object o)           Determine whether this Object is semantically equal to another Object.
java.lang.String	getAlgorithm()           Return the name of the algorithm associated with this secret key.
byte[]	getEncoded()           Return the key as a byte array.
java.lang.String	getFormat()           This key's format, which is always "RAW".
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.

 

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

serialVersionUID

private static final long serialVersionUID

Compatible with JDK1.4.

See Also:

Constant Field Values

---

key

private byte[] key

The key bytes.

---

algorithm

private java.lang.String algorithm

The algorithm's name.

Constructor Detail

SecretKeySpec

public SecretKeySpec(byte[] key,
                     java.lang.String algorithm)

Create a new secret key spec from an entire byte array.

---

SecretKeySpec

public SecretKeySpec(byte[] key,
                     int off,
                     int len,
                     java.lang.String algorithm)

Create a new secret key spec from part of a byte array.

Method Detail

getAlgorithm

public java.lang.String getAlgorithm()

Return the name of the algorithm associated with this secret key.

Specified by:

getAlgorithm in interface java.security.Key

---

getEncoded

public byte[] getEncoded()

Return the key as a byte array.

Specified by:

getEncoded in interface java.security.Key

---

getFormat

public java.lang.String getFormat()

This key's format, which is always "RAW".

Specified by:

getFormat in interface java.security.Key

---

equals

public boolean equals(java.lang.Object o)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> crypto >> [ spec overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---