Shuyi Chen | d7955ce | 2013-05-22 14:51:55 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | * contributor license agreements. See the NOTICE file distributed with |
| 4 | * this work for additional information regarding copyright ownership. |
| 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | * (the "License"); you may not use this file except in compliance with |
| 7 | * the License. You may obtain a copy of the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | * See the License for the specific language governing permissions and |
| 15 | * limitations under the License. |
| 16 | */ |
| 17 | |
| 18 | package org.apache.harmony.javax.security.auth; |
| 19 | |
| 20 | /** |
| 21 | * Allows for special treatment of sensitive information, when it comes to |
| 22 | * destroying or clearing of the data. |
| 23 | */ |
| 24 | public interface Destroyable { |
| 25 | |
| 26 | /** |
| 27 | * Erases the sensitive information. Once an object is destroyed any calls |
| 28 | * to its methods will throw an {@code IllegalStateException}. If it does |
| 29 | * not succeed a DestroyFailedException is thrown. |
| 30 | * |
| 31 | * @throws DestroyFailedException |
| 32 | * if the information cannot be erased. |
| 33 | */ |
| 34 | void destroy() throws DestroyFailedException; |
| 35 | |
| 36 | /** |
| 37 | * Returns {@code true} once an object has been safely destroyed. |
| 38 | * |
| 39 | * @return whether the object has been safely destroyed. |
| 40 | */ |
| 41 | boolean isDestroyed(); |
| 42 | |
| 43 | } |