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.delta;
35
36 import info.magnolia.importexport.BootstrapUtil;
37 import info.magnolia.module.InstallContext;
38
39 import java.io.IOException;
40
41 import javax.jcr.RepositoryException;
42
43 /**
44 * A Task which bootstraps a single file.
45 *
46 * <p>If this file is located in the default dir ("<code>/mgnl-bootstrap/<yourModuleName></code>") or in a sub
47 * directory of it, you should use {@link info.magnolia.module.delta.BootstrapSingleModuleResource} instead.</p>
48 */
49 public class BootstrapSingleResource extends BootstrapResourcesTask {
50 private final String resource;
51 private final String subPath;
52
53 public BootstrapSingleResource(String name, String description, String resource) {
54 super(name, description);
55 this.resource = resource;
56 this.subPath = null;
57 }
58
59 public BootstrapSingleResource(String name, String description, String resource, int importUUIDBehavior) {
60 super(name, description, importUUIDBehavior);
61 this.resource = resource;
62 this.subPath = null;
63 }
64
65 public BootstrapSingleResource(String name, String description, String resource, String subPath) {
66 super(name, description);
67 this.resource = resource;
68 this.subPath = subPath;
69 }
70
71 public BootstrapSingleResource(String name, String description, String resource, String subPath, int importUUIDBehavior) {
72 super(name, description, importUUIDBehavior);
73 this.resource = resource;
74 this.subPath = subPath;
75 }
76
77 @Override
78 protected void bootstrap(InstallContext installContext, int importUUIDBehavior) throws IOException, RepositoryException {
79 if (subPath == null) {
80 super.bootstrap(installContext, importUUIDBehavior);
81 } else {
82 final String[] resourcesToBootstrap = getResourcesToBootstrap(installContext);
83 BootstrapUtil.bootstrap(resourcesToBootstrap[0], subPath, importUUIDBehavior);
84 }
85 }
86
87 @Override
88 protected String[] getResourcesToBootstrap(final InstallContext installContext) {
89 return new String[]{resource};
90 }
91 }