1 /**
2 * This file Copyright (c) 2003-2010 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
47 * to set the current "phase" of installation; other ModuleLifecycleContext clients
48 * have read-only access to the phase.
49 *
50 * @author gjoseph
51 * @version $Revision: $ ($Author: $)
52 */
53 public class ModuleLifecycleContextImpl implements ModuleLifecycleContext {
54 /**
55 * A Map<String,ObservedManager%gt;, mapping nodenames to components.
56 */
57 private final Map<String, ObservedManager> components;
58
59 private int phase;
60
61 private ModuleDefinition currentModuleDefinition;
62
63 ModuleLifecycleContextImpl() {
64 components = new LinkedHashMap<String, ObservedManager>();
65 }
66
67 public void registerModuleObservingComponent(String nodeName, ObservedManager component) {
68 if (components.containsKey(nodeName)) {
69 final Object currentObservedManager = components.get(nodeName);
70 throw new IllegalStateException("ObservedManager " + currentObservedManager + " was already registered for nodes of name " + nodeName + ", " + component + " can't be registered.");
71 } else {
72 components.put(nodeName, component);
73 }
74 }
75
76 /**
77 * @param moduleNodes a Collection<Content> of module nodes.
78 */
79 public void start(Collection<Content> moduleNodes) {
80 for (String nodeName : components.keySet()) {
81 final ObservedManager component = components.get(nodeName);
82 for (Content moduleNode : moduleNodes) {
83 initEntry(moduleNode, nodeName, component);
84 }
85 }
86 }
87
88 private void initEntry(Content moduleNode, String nodeName, ObservedManager observedManager) {
89 final Content node = ContentUtil.getCaseInsensitive(moduleNode, nodeName);
90 if (node != null) {
91 observedManager.register(node);
92 }
93 }
94
95 public ModuleDefinition getCurrentModuleDefinition() {
96 return this.currentModuleDefinition;
97 }
98
99 public void setCurrentModuleDefinition(ModuleDefinition currentModuleDefinition) {
100 this.currentModuleDefinition = currentModuleDefinition;
101 }
102
103
104 public int getPhase() {
105 return this.phase;
106 }
107
108
109 public void setPhase(int phase) {
110 this.phase = phase;
111 }
112 }