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.cms.core.Content;
38 import info.magnolia.cms.util.ContentUtil;
39 import info.magnolia.module.model.ModuleDefinition;
40
41 import java.util.Collection;
42 import java.util.LinkedHashMap;
43 import java.util.Map;
44
45 /**
46 * This default implementation of ModuleLifecycleContext allows the ModuleManager to set the current "phase" of
47 * installation; other ModuleLifecycleContext clients have read-only access to the phase.
48 */
49 public class ModuleLifecycleContextImpl implements ModuleLifecycleContext {
50 /**
51 * A Map<String,ObservedManager%gt;, mapping nodenames to components.
52 */
53 private final Map<String, ObservedManager> components;
54
55 private int phase;
56
57 private ModuleDefinition currentModuleDefinition;
58
59 public ModuleLifecycleContextImpl() {
60 components = new LinkedHashMap<String, ObservedManager>();
61 }
62
63 /**
64 * @deprecated since 5.5. Use {@link info.magnolia.cms.util.ModuleConfigurationObservingManager} instead.
65 */
66 @Deprecated
67 @Override
68 public void registerModuleObservingComponent(String nodeName, ObservedManager component) {
69 if (components.containsKey(nodeName)) {
70 final Object currentObservedManager = components.get(nodeName);
71 throw new IllegalStateException("ObservedManager " + currentObservedManager + " was already registered for nodes of name " + nodeName + ", " + component + " can't be registered.");
72 }
73 components.put(nodeName, component);
74 }
75
76 /**
77 * @param moduleNodes a Collection<Content> of module nodes.
78 * @deprecated since 5.5. Use {@link info.magnolia.cms.util.ModuleConfigurationObservingManager} instead.
79 */
80 @Deprecated
81 public void start(Collection<Content> moduleNodes) {
82 for (String nodeName : components.keySet()) {
83 final ObservedManager component = components.get(nodeName);
84 for (Content moduleNode : moduleNodes) {
85 initEntry(moduleNode, nodeName, component);
86 }
87 }
88 }
89
90 private void initEntry(Content moduleNode, String nodeName, ObservedManager observedManager) {
91 final Content node = ContentUtil.getCaseInsensitive(moduleNode, nodeName);
92 if (node != null) {
93 observedManager.register(node);
94 }
95 }
96
97 @Override
98 public ModuleDefinition getCurrentModuleDefinition() {
99 return this.currentModuleDefinition;
100 }
101
102 public void setCurrentModuleDefinition(ModuleDefinition currentModuleDefinition) {
103 this.currentModuleDefinition = currentModuleDefinition;
104 }
105
106
107 @Override
108 public int getPhase() {
109 return this.phase;
110 }
111
112
113 public void setPhase(int phase) {
114 this.phase = phase;
115 }
116 }