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