PBEKey (Java SE 9 & JDK 9 ) (original) (raw)

• All Superinterfaces:
  [Destroyable](../../../javax/security/auth/Destroyable.html "interface in javax.security.auth"), [Key](../../../java/security/Key.html "interface in java.security"), [SecretKey](../../../javax/crypto/SecretKey.html "interface in javax.crypto"), [Serializable](../../../java/io/Serializable.html "interface in java.io")

public interface PBEKey
extends SecretKey
The interface to a PBE key.
Since:
1.4
See Also:
PBEKeySpec, SecretKey

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static long	serialVersionUID	The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  int	getIterationCount​()	Returns the iteration count or 0 if not specified.
  char[]	getPassword​()	Returns the password.
  byte[]	getSalt​()	Returns the salt or null if not specified.

     * ### Methods inherited from interface javax.security.auth.[Destroyable](../../../javax/security/auth/Destroyable.html "interface in javax.security.auth")  
     `[destroy](../../../javax/security/auth/Destroyable.html#destroy--), [isDestroyed](../../../javax/security/auth/Destroyable.html#isDestroyed--)`  
     * ### Methods inherited from interface java.security.[Key](../../../java/security/Key.html "interface in java.security")  
     `[getAlgorithm](../../../java/security/Key.html#getAlgorithm--), [getEncoded](../../../java/security/Key.html#getEncoded--), [getFormat](../../../java/security/Key.html#getFormat--)`

• • Field Detail

     * #### serialVersionUID  
     static final long serialVersionUID  
     The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.  
     See Also:  
     [Constant Field Values](../../../constant-values.html#javax.crypto.interfaces.PBEKey.serialVersionUID)  

  • Method Detail

    * #### getPassword  
    char[] getPassword​()  
    Returns the password.  
     Note: this method should return a copy of the password. It is the caller's responsibility to zero out the password information after it is no longer needed.  
    Returns:  
    the password.  
    * #### getSalt  
    byte[] getSalt​()  
    Returns the salt or null if not specified.  
     Note: this method should return a copy of the salt. It is the caller's responsibility to zero out the salt information after it is no longer needed.  
    Returns:  
    the salt.  
    * #### getIterationCount  
    int getIterationCount​()  
    Returns the iteration count or 0 if not specified.  
    Returns:  
    the iteration count.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2017, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.