| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Portions Copyright 2000-2005 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 | * @author IBM Corp. |
| 27 | * |
| 28 | * Copyright IBM Corp. 1999-2000. All rights reserved. |
| 29 | */ |
| 30 | |
| 31 | package javax.management; |
| 32 | |
| 33 | import javax.management.MBeanException; |
| 34 | import javax.management.RuntimeOperationsException; |
| 35 | import javax.management.InstanceNotFoundException; |
| 36 | |
| 37 | /** |
| 38 | * This class is the interface to be implemented by MBeans that are meant to be |
| 39 | * persistent. MBeans supporting this interface should call the load method during |
| 40 | * construction in order to prime the MBean from the persistent store. |
| 41 | * In the case of a ModelMBean, the store method should be called by the MBeanServer based on the descriptors in |
| 42 | * the ModelMBean or by the MBean itself during normal processing of the ModelMBean. |
| 43 | * |
| 44 | * @since 1.5 |
| 45 | */ |
| 46 | public interface PersistentMBean { |
| 47 | |
| 48 | |
| 49 | /** |
| 50 | * Instantiates thisMBean instance with the data found for |
| 51 | * the MBean in the persistent store. The data loaded could include |
| 52 | * attribute and operation values. |
| 53 | * |
| 54 | * This method should be called during construction or initialization of this instance, |
| 55 | * and before the MBean is registered with the MBeanServer. |
| 56 | * |
| 57 | * @exception MBeanException Wraps another exception or persistence is not supported |
| 58 | * @exception RuntimeOperationsException Wraps exceptions from the persistence mechanism |
| 59 | * @exception InstanceNotFoundException Could not find or load this MBean from persistent |
| 60 | * storage |
| 61 | */ |
| 62 | public void load() |
| 63 | throws MBeanException, RuntimeOperationsException, InstanceNotFoundException; |
| 64 | |
| 65 | /** |
| 66 | * Captures the current state of this MBean instance and |
| 67 | * writes it out to the persistent store. The state stored could include |
| 68 | * attribute and operation values. If one of these methods of persistence is |
| 69 | * not supported a "serviceNotFound" exception will be thrown. |
| 70 | * <P> |
| 71 | * Persistence policy from the MBean and attribute descriptor is used to guide execution |
| 72 | * of this method. The MBean should be stored if 'persistPolicy' field is: |
| 73 | * <PRE> != "never" |
| 74 | * = "always" |
| 75 | * = "onTimer" and now > 'lastPersistTime' + 'persistPeriod' |
| 76 | * = "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod' |
| 77 | * = "onUnregister" |
| 78 | * <P> |
| 79 | * Do not store the MBean if 'persistPolicy' field is: |
| 80 | * = "never" |
| 81 | * = "onUpdate" |
| 82 | * = "onTimer" && now < 'lastPersistTime' + 'persistPeriod' |
| 83 | * <P></PRE> |
| 84 | * |
| 85 | * @exception MBeanException Wraps another exception or persistence is not supported |
| 86 | * @exception RuntimeOperationsException Wraps exceptions from the persistence mechanism |
| 87 | * @exception InstanceNotFoundException Could not find/access the persistent store |
| 88 | */ |
| 89 | public void store() |
| 90 | throws MBeanException, RuntimeOperationsException, InstanceNotFoundException; |
| 91 | |
| 92 | } |