View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.module.delta.DeltaType;
41  import info.magnolia.objectfactory.Components;
42  
43  import java.util.ArrayList;
44  import java.util.EnumSet;
45  import java.util.HashSet;
46  import java.util.List;
47  import java.util.Set;
48  
49  /**
50   * ModuleManager is responsible for the lifecycle of modules.
51   * (loads definitions, install/update/uninstall, start/stop)
52   *
53   * @author gjoseph
54   * @version $Revision: $ ($Author: $)
55   */
56  public interface ModuleManager {
57  
58      /**
59       * Loads modules definitions, validates dependencies and sorts modules
60       * by dependencies.
61       */
62      List<ModuleDefinition> loadDefinitions() throws ModuleManagementException;
63  
64      /**
65       * Checks if we need to do any module installation, update or uninstall.
66       */
67      void checkForInstallOrUpdates() throws ModuleManagementException;
68  
69      /**
70       * Returns the status as discovered by checkForInstallOrUpdates().
71       * @throws IllegalStateException if checkForInstallOrUpdates was never called.
72       */
73      ModuleManagementState getStatus();
74  
75      ModuleManagerUI getUI();
76  
77      void performInstallOrUpdate();
78  
79      InstallContext getInstallContext();
80  
81      void startModules();
82  
83      void stopModules();
84  
85      /**
86       * Use this to retrieve the configured singleton impl of ModuleManager.
87       */
88      public class Factory {
89          public static ModuleManager getInstance() {
90              return Components.getSingleton(ModuleManager.class);
91          }
92      }
93  
94      /**
95       * Represent what's to be done for all modules.
96       */
97      public final static class ModuleManagementState {
98          private final List<ModuleAndDeltas> list;
99          private EnumSet<DeltaType> cachedDeltaTypes;
100 
101         public ModuleManagementState() {
102             this.list = new ArrayList<ModuleAndDeltas>();
103         }
104 
105         public boolean needsUpdateOrInstall() {
106             return !(list.isEmpty());
107         }
108 
109         void addModule(ModuleDefinition module, Version currentVersion, List<Delta> deltas) {
110             list.add(new ModuleAndDeltas(module, currentVersion, deltas));
111         }
112 
113         public List<ModuleAndDeltas> getList() {
114             return list;
115         }
116 
117         /**
118          * Returns one of the given Strings depending on the combination of delta types
119          * in the registered deltas. Typical use:
120          * <code>
121          * getDeltaTypesDescription({"modules need to be installed", "modules need to be installed", "modules need to be installed or updated"});
122          * </code>
123          * @param texts
124          * @return
125          */
126         public String getDeltaTypesDescription(String[] texts) {
127             if (texts == null || texts.length != 3) {
128                 throw new IllegalStateException("Please pass an array of 3 strings.");
129             }
130 
131             // we can cache this, since this method is only used after all modules' deltas have been registered.
132             if (cachedDeltaTypes == null) {
133                 cachedDeltaTypes = getDeltaTypes();
134             }
135 
136             if (cachedDeltaTypes.size() == 1) {
137                 if (cachedDeltaTypes.contains(DeltaType.install)) {
138                     return texts[0];
139                 } else if (cachedDeltaTypes.contains(DeltaType.update)) {
140                     return texts[1];
141                 }
142             } else if (cachedDeltaTypes.size() == 2) {
143                 if (cachedDeltaTypes.containsAll(EnumSet.<DeltaType>of(DeltaType.install, DeltaType.update))) {
144                     return texts[2];
145                 }
146             }
147             throw new IllegalStateException("Unhandled delta types combination: " + cachedDeltaTypes);
148         }
149 
150         protected EnumSet<DeltaType> getDeltaTypes() {
151             if (list.isEmpty()) {
152                 throw new IllegalStateException("No registered deltas");
153             }
154             final Set<DeltaType> types = new HashSet<DeltaType>();
155             for (ModuleAndDeltas moduleAndDeltas : list) {
156                 for (Delta delta : moduleAndDeltas.getDeltas()) {
157                     types.add(delta.getType());
158                 }
159             }
160             return EnumSet.copyOf(types);
161         }
162     }
163 
164     /**
165      * Represents what's to be done for each module.
166      */
167     public final static class ModuleAndDeltas {
168         private final ModuleDefinition module;
169         private final Version currentVersion;
170         private final List<Delta> deltas;
171 
172         public ModuleAndDeltas(ModuleDefinition module, Version currentVersion, List<Delta> deltas) {
173             this.module = module;
174             this.currentVersion = currentVersion;
175             this.deltas = deltas;
176         }
177 
178         public ModuleDefinition getModule() {
179             return module;
180         }
181 
182         public Version getCurrentVersion() {
183             return currentVersion;
184         }
185 
186         public List<Delta> getDeltas() {
187             return deltas;
188         }
189 
190         public String toString() {
191             final StringBuffer sb = new StringBuffer("ModuleAndDeltas for ");
192             sb.append(module.getName());
193             if (currentVersion != null) {
194                 sb.append(": current version is ");
195                 sb.append(currentVersion);
196                 sb.append(", updating to ");
197             } else {
198                 sb.append(": installing version ");
199             }
200             sb.append(module.getVersion());
201             sb.append(" with ");
202             sb.append(deltas.size());
203             sb.append(" deltas.");
204             return sb.toString();
205         }
206     }
207 
208 }