1/*
2 * Copyright (c) 2000, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25/*
26 * @author    IBM Corp.
27 *
28 * Copyright IBM Corp. 1999-2000.  All rights reserved.
29 */
30
31package javax.management;
32
33import javax.management.MBeanException;
34import javax.management.RuntimeOperationsException;
35import 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 */
46public 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>{@literal  != "never"
74     *   = "always"
75     *   = "onTimer" and now > 'lastPersistTime' + 'persistPeriod'
76     *   = "NoMoreOftenThan" and now > 'lastPersistTime' + 'persistPeriod'
77     *   = "onUnregister"
78     * }</PRE>
79     * <p>
80     * Do not store the MBean if 'persistPolicy' field is:
81     * <PRE>{@literal
82     *    = "never"
83     *    = "onUpdate"
84     *    = "onTimer" && now < 'lastPersistTime' + 'persistPeriod'
85     * }</PRE>
86     *
87     * @exception MBeanException Wraps another exception or persistence is not supported
88     * @exception RuntimeOperationsException Wraps exceptions from the persistence mechanism
89     * @exception InstanceNotFoundException Could not find/access the persistent store
90     */
91    public void store()
92    throws MBeanException, RuntimeOperationsException, InstanceNotFoundException;
93
94}
95