Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.crypto.interfaces
Interface PBEKey  view PBEKey download PBEKey.java

All Superinterfaces:
java.security.Key, javax.crypto.SecretKey, java.io.Serializable

public interface PBEKey
extends javax.crypto.SecretKey

Interface to a password-derived key for password-based encryption (PBE). Applications working with a javax.crypto.SecretKey that is known to be a password-based key can safely cast such keys to this interface.

Since:
1.4

Field Summary
static long serialVersionUID
          Compatible with JDK1.4.
 
Method Summary
 int getIterationCount()
          Retruns the iteration count, or 0 if not specified.
 char[] getPassword()
          Returns a copy of the password as a character array.
 byte[] getSalt()
          Returns a copy of the salt.
 
Methods inherited from interface java.security.Key
getAlgorithm, getEncoded, getFormat
 

Field Detail

serialVersionUID

public static final long serialVersionUID
Compatible with JDK1.4.

See Also:
Constant Field Values
Method Detail

getIterationCount

public int getIterationCount()
Retruns the iteration count, or 0 if not specified.


getPassword

public char[] getPassword()
Returns a copy of the password as a character array. It is the caller's responsibility to zero-out the password when it is no longer in use.

Although it is not specified in the documentation, implementations should not copy or clone the password array, but rather return the reference to the array itself, so the caller has the ability to erase the password.


getSalt

public byte[] getSalt()
Returns a copy of the salt. It is the caller's responsibility to zero-out the salt when it is no longer in use.

Although it is not specified in the documentation, implementations should not copy or clone the salt array, but rather return the reference to the array itself, so the caller has the ability to erase the salt.