Java 2 Platform EE v1.3: Interface Destroyable - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.security.auth
Interface Destroyable

public interface Destroyable

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

See Also:: Subject

Method Summary

void destroy()
Destroy this Object.

boolean isDestroyed()
Determine if this Object has been destroyed.

Method Detail

destroy

public 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.

Throws:: DestroyFailedException - if the destroy operation fails.; java.lang.SecurityException - if the caller does not have permission to destroy this Object.

isDestroyed

public boolean isDestroyed()

Determine if this Object has been destroyed.

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