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.cms.core.Content;
37 import info.magnolia.cms.core.HierarchyManager;
38 import info.magnolia.module.model.ModuleDefinition;
39 import org.apache.commons.lang.exception.ExceptionUtils;
40
41 import javax.jcr.RepositoryException;
42 import java.util.Date;
43 import java.util.List;
44 import java.util.Map;
45
46 /**
47 * The {@link info.magnolia.module.InstallContext} provides {@link info.magnolia.module.delta.Task}s
48 * and install/update UI with methods to log, get content and status.
49 *
50 * @author gjoseph
51 * @version $Revision: $ ($Author: $)
52 */
53 public interface InstallContext {
54
55 void info(String message);
56
57 void warn(String message);
58
59 void error(String message, Throwable th);
60
61 void restartNeeded(String message);
62
63 int getExecutedTaskCount();
64
65 int getTotalTaskCount();
66
67 InstallStatus getStatus();
68
69 /**
70 * A Map of messages where the key is the module name.
71 */
72 Map<String, List<Message>> getMessages();
73
74 HierarchyManager getHierarchyManager(String workspace);
75
76 HierarchyManager getConfigHierarchyManager();
77
78 boolean hasModulesNode();
79
80 /**
81 * @return the root node for all modules in the config workspace.
82 */
83 Content getModulesNode() throws RepositoryException;
84
85 Content getOrCreateCurrentModuleNode() throws RepositoryException;
86
87 Content getOrCreateCurrentModuleConfigNode() throws RepositoryException;
88
89 /**
90 * Allows generic tasks to know what's being installed/updated.
91 */
92 ModuleDefinition getCurrentModuleDefinition();
93
94 boolean isModuleRegistered(String moduleName);
95
96 /**
97 * Log messages kept in the InstallContext.
98 */
99 public static final class Message {
100 private final Date timestamp;
101 private final String message;
102 private final String details;
103 private final MessagePriority priority;
104
105 public Message(MessagePriority priority, String message) {
106 this(priority, message, (String) null);
107 }
108
109 public Message(MessagePriority priority, String message, Throwable th) {
110 this(priority, message, th != null ? ExceptionUtils.getStackTrace(th) : null);
111 }
112
113 public Message(MessagePriority priority, String message, String details) {
114 this.timestamp = new Date();
115 this.priority = priority;
116 this.message = message;
117 this.details = details;
118 }
119
120 public Date getTimestamp() {
121 return timestamp;
122 }
123
124 public String getMessage() {
125 return message;
126 }
127
128 public String getDetails() {
129 return details;
130 }
131
132 public MessagePriority getPriority() {
133 return priority;
134 }
135 }
136
137 /**
138 * Priority for {@link info.magnolia.module.InstallContext.Message}s.
139 */
140 public enum MessagePriority {
141 info, warning, error, restartNeeded
142 }
143 }