KeyStore.PasswordProtection (Java Platform SE 7 ) (original) (raw)

• java.lang.Object

• • java.security.KeyStore.PasswordProtection

• All Implemented Interfaces:
  KeyStore.ProtectionParameter, Destroyable
  Enclosing class:
  KeyStore

public static class KeyStore.PasswordProtection
extends Object
implements KeyStore.ProtectionParameter, Destroyable
A password-based implementation of ProtectionParameter.
Since:
1.5

• • Constructor Summary

  Constructors

  Constructor and Description
  KeyStore.PasswordProtection(char[] password) Creates a password parameter.

  • Method Summary

  Methods

  Modifier and Type	Method and Description
  void	destroy() Clears the password.
  char[]	getPassword() Gets the password.
  boolean	isDestroyed() Determines if password has been cleared.

     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,%20int%29)`

• • Constructor Detail

     * #### KeyStore.PasswordProtection  
     public KeyStore.PasswordProtection(char[] password)  
     Creates a password parameter.  
      The specified `password` is cloned before it is stored in the new `PasswordProtection` object.  
     Parameters:  
     `password` \- the password, which may be `null`  

  • Method Detail

    * #### getPassword  
    public char[] getPassword()  
    Gets the password.  
    Note that this method returns a reference to the password. If a clone of the array is created it is the caller's responsibility to zero out the password information after it is no longer needed.  
    Returns:  
    the password, which may be `null`  
    Throws:  
    `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- if the password has been cleared (destroyed)  
    See Also:  
    [destroy()](../../java/security/KeyStore.PasswordProtection.html#destroy%28%29)  
    * #### destroy  
    public void destroy()  
                 throws [DestroyFailedException](../../javax/security/auth/DestroyFailedException.html "class in javax.security.auth")  
    Clears the password.  
    **Specified by:**  
    `[destroy](../../javax/security/auth/Destroyable.html#destroy%28%29)` in interface `[Destroyable](../../javax/security/auth/Destroyable.html "interface in javax.security.auth")`  
    Throws:  
    `DestroyFailedException` \- if this method was unable to clear the password  
    * #### isDestroyed  
    public boolean isDestroyed()  
    Determines if password has been cleared.  
    **Specified by:**  
    `[isDestroyed](../../javax/security/auth/Destroyable.html#isDestroyed%28%29)` in interface `[Destroyable](../../javax/security/auth/Destroyable.html "interface in javax.security.auth")`  
    Returns:  
    true if the password has been cleared, false otherwise

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.