View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module;
35  
36  import info.magnolia.cms.beans.config.ObservedManager;
37  import info.magnolia.module.model.ModuleDefinition;
38  
39  /**
40   * This interface currently provides a hook allowing modules to register ObserverManager
41   * instances, which can observer other modules' nodes. In the future, it might provide
42   * other callback methods relevant to the lifecycle management of a module.
43   */
44  public interface ModuleLifecycleContext {
45  
46      /**
47       * System is starting up.
48       */
49      public int PHASE_SYSTEM_STARTUP = 1;
50  
51      /**
52       * A module is restarted. This is triggered through observation (change in the config node).
53       */
54      public int PHASE_MODULE_RESTART = 2;
55  
56      /**
57       * The system is shutting down.
58       */
59      public int PHASE_SYSTEM_SHUTDOWN = 3;
60  
61  
62      /**
63       * Gets the current module definition.
64       */
65      ModuleDefinition getCurrentModuleDefinition();
66  
67  
68      /**
69       * Returns the phase the lifecycle is in. This is one of the phase constants.
70       */
71      int getPhase();
72  
73      /**
74       * Registers a component which will observe other modules' config node with
75       * the given nodeName.
76       *
77       * @deprecated since 5.5. Use {@link info.magnolia.cms.util.ModuleConfigurationObservingManager} instead.
78       */
79      @Deprecated
80      void registerModuleObservingComponent(String nodeName, ObservedManager component);
81  
82  }