javax.security.auth

Interface Destroyable

All Known Subinterfaces:

PrivateKey, SecretKey

All Known Implementing Classes:

SecretKeySpec

public interface Destroyable

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

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy this Object.
boolean	isDestroyed() Determine if this Object has been destroyed.

Method Detail

destroy

void destroy()
      throws DestroyFailedException

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.

Throws:

DestroyFailedException - if the destroy operation fails.

SecurityException - if the caller does not have permission to destroy this Object.

isDestroyed

boolean isDestroyed()

Determine if this Object has been destroyed.

The default implementation returns false.

Returns:

true if this Object has been destroyed, false otherwise.