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.ui;
35
36 import info.magnolia.module.ModuleManagementException;
37
38 import java.io.Writer;
39
40 /**
41 * User Interface for the install/update mechanism.
42 * Instances are not to be reused, client code should re-instanciate for each request.
43 */
44 public interface ModuleManagerUI {
45
46 void onStartup() throws ModuleManagementException;
47
48 /**
49 * @return a boolean indicating if the request should go through or pause until next user action.
50 */
51 boolean execute(Writer out, String command) throws ModuleManagementException;
52
53 /**
54 * Not used anymore since 4.4 - but keeping this around; in the future, we might re-use this,
55 * as the page shown to regular users while the Magnolia instance is being updated by an admin;
56 * only admin(s) would have access to the update status pages.
57 */
58 void renderTempPage(Writer out) throws ModuleManagementException;
59 }