01 /*
02 * Copyright 1999 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.security.auth;
27
28 /**
29 * Objects such as credentials may optionally implement this interface
30 * to provide the capability to destroy its contents.
31 *
32 * @version 1.18, 05/05/07
33 * @see javax.security.auth.Subject
34 */
35 public interface Destroyable {
36
37 /**
38 * Destroy this <code>Object</code>.
39 *
40 * <p> Sensitive information associated with this <code>Object</code>
41 * is destroyed or cleared. Subsequent calls to certain methods
42 * on this <code>Object</code> will result in an
43 * <code>IllegalStateException</code> being thrown.
44 *
45 * <p>
46 *
47 * @exception DestroyFailedException if the destroy operation fails. <p>
48 *
49 * @exception SecurityException if the caller does not have permission
50 * to destroy this <code>Object</code>.
51 */
52 void destroy() throws DestroyFailedException;
53
54 /**
55 * Determine if this <code>Object</code> has been destroyed.
56 *
57 * <p>
58 *
59 * @return true if this <code>Object</code> has been destroyed,
60 * false otherwise.
61 */
62 boolean isDestroyed();
63 }
|