Destroyable

public interface Destroyable

javax.security.auth.Destroyable

Known indirect subclasses

DHPrivateKey, DSAPrivateKey, ECPrivateKey, EdECPrivateKey, KeyStore.PasswordProtection, PBEKey, PrivateKey, RSAMultiPrimePrivateCrtKey, RSAPrivateCrtKey, RSAPrivateKey, SecretKey, SecretKeySpec, X500PrivateCredential, XECPrivateKey

DHPrivateKey	The interface to a Diffie-Hellman private key.
DSAPrivateKey	The standard interface to a DSA private key.
ECPrivateKey	The interface to an elliptic curve (EC) private key.
EdECPrivateKey	An interface for an elliptic curve private key as defined by RFC 8032: Edwards-Curve Digital Signature Algorithm (EdDSA).
KeyStore.PasswordProtection	A password-based implementation of `ProtectionParameter`.
PBEKey	The interface to a PBE key.
PrivateKey	A private key.
RSAMultiPrimePrivateCrtKey	The interface to an RSA multi-prime private key, as defined in the PKCS#1 v2.2 standard, using the Chinese Remainder Theorem (CRT) information values.
RSAPrivateCrtKey	The interface to an RSA private key, as defined in the PKCS#1 v2.2 standard, using the Chinese Remainder Theorem (CRT) information values.
RSAPrivateKey	The interface to an RSA private key.
SecretKey	A secret (symmetric) key.
SecretKeySpec	This class specifies a secret key in a provider-independent fashion.
X500PrivateCredential	This class represents an `X500PrivateCredential`.
XECPrivateKey	An interface for an elliptic curve private key as defined by RFC 7748.

Objects such as credentials may optionally implement this interface to provide the capability to destroy its contents.

See also:

Subject

Summary

Public methods
`default void`	`destroy()` Destroy this `Object`.
`default boolean`	`isDestroyed()` Determine if this `Object` has been destroyed.

Public methods

destroy

Added in API level 1

public void destroy ()

Destroy this Object.

Sensitive information associated with this Object is destroyed or cleared. Subsequent calls to certain methods on this Object will result in an IllegalStateException being thrown.

The default implementation throws DestroyFailedException.

Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.

Throws
`DestroyFailedException`	if the destroy operation fails.
`SecurityException`	if the caller does not have permission to destroy this `Object`.

isDestroyed

Added in API level 1

public boolean isDestroyed ()

Determine if this Object has been destroyed.

The default implementation returns false.

Returns
`boolean`	true if this `Object` has been destroyed, false otherwise.