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.module.model.ModuleDefinition;
37 import info.magnolia.module.model.Version;
38 import info.magnolia.module.ui.ModuleManagerUI;
39 import info.magnolia.module.delta.Delta;
40 import info.magnolia.objectfactory.Components;
41
42 import java.util.ArrayList;
43 import java.util.List;
44
45 /**
46 * ModuleManager is responsible for the lifecycle of modules.
47 * (loads definitions, install/update/uninstall, start/stop)
48 *
49 * @author gjoseph
50 * @version $Revision: $ ($Author: $)
51 */
52 public interface ModuleManager {
53
54 /**
55 * Loads modules definitions, validates dependencies and sorts modules
56 * by dependencies.
57 */
58 List<ModuleDefinition> loadDefinitions() throws ModuleManagementException;
59
60 /**
61 * Checks if we need to do any module installation, update or uninstall.
62 */
63 void checkForInstallOrUpdates() throws ModuleManagementException;
64
65 /**
66 * Returns the status as discovered by checkForInstallOrUpdates().
67 * @throws IllegalStateException if checkForInstallOrUpdates was never called.
68 */
69 ModuleManagementState getStatus();
70
71 ModuleManagerUI getUI();
72
73 void performInstallOrUpdate();
74
75 InstallContext getInstallContext();
76
77 void startModules();
78
79 void stopModules();
80
81 /**
82 * Use this to retrieve the configured singleton impl of ModuleManager.
83 */
84 public class Factory {
85 public static ModuleManager getInstance() {
86 return Components.getSingleton(ModuleManager.class);
87 }
88 }
89
90 /**
91 * Represent what's to be done for all modules.
92 */
93 public final static class ModuleManagementState {
94 private final List<ModuleAndDeltas> list;
95
96 public ModuleManagementState() {
97 this.list = new ArrayList<ModuleAndDeltas>();
98 }
99
100 public boolean needsUpdateOrInstall() {
101 return !(list.isEmpty());
102 }
103
104 void addModule(ModuleDefinition module, Version currentVersion, List<Delta> deltas) {
105 list.add(new ModuleAndDeltas(module, currentVersion, deltas));
106 }
107
108 public List<ModuleAndDeltas> getList() {
109 return list;
110 }
111 }
112
113 /**
114 * Represents what's to be done for each module.
115 */
116 public final static class ModuleAndDeltas {
117 private final ModuleDefinition module;
118 private final Version currentVersion;
119 private final List<Delta> deltas;
120
121 public ModuleAndDeltas(ModuleDefinition module, Version currentVersion, List<Delta> deltas) {
122 this.module = module;
123 this.currentVersion = currentVersion;
124 this.deltas = deltas;
125 }
126
127 public ModuleDefinition getModule() {
128 return module;
129 }
130
131 public Version getCurrentVersion() {
132 return currentVersion;
133 }
134
135 public List<Delta> getDeltas() {
136 return deltas;
137 }
138
139 public String toString() {
140 final StringBuffer sb = new StringBuffer("ModuleAndDeltas for ");
141 sb.append(module.getName());
142 if (currentVersion != null) {
143 sb.append(": current version is ");
144 sb.append(currentVersion);
145 sb.append(", updating to ");
146 } else {
147 sb.append(": installing version ");
148 }
149 sb.append(module.getVersion());
150 sb.append(" with ");
151 sb.append(deltas.size());
152 sb.append(" deltas.");
153 return sb.toString();
154 }
155 }
156
157 }