| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1999 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * 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 | * @see javax.security.auth.Subject |
| 33 | */ |
| 34 | public interface Destroyable { |
| 35 | |
| 36 | /** |
| 37 | * Destroy this <code>Object</code>. |
| 38 | * |
| 39 | * <p> Sensitive information associated with this <code>Object</code> |
| 40 | * is destroyed or cleared. Subsequent calls to certain methods |
| 41 | * on this <code>Object</code> will result in an |
| 42 | * <code>IllegalStateException</code> being thrown. |
| 43 | * |
| 44 | * <p> |
| 45 | * |
| 46 | * @exception DestroyFailedException if the destroy operation fails. <p> |
| 47 | * |
| 48 | * @exception SecurityException if the caller does not have permission |
| 49 | * to destroy this <code>Object</code>. |
| 50 | */ |
| 51 | void destroy() throws DestroyFailedException; |
| 52 | |
| 53 | /** |
| 54 | * Determine if this <code>Object</code> has been destroyed. |
| 55 | * |
| 56 | * <p> |
| 57 | * |
| 58 | * @return true if this <code>Object</code> has been destroyed, |
| 59 | * false otherwise. |
| 60 | */ |
| 61 | boolean isDestroyed(); |
| 62 | } |