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.delta;
35
36 import info.magnolia.cms.util.ClasspathResourcesUtil;
37 import info.magnolia.importexport.BootstrapUtil;
38 import info.magnolia.module.InstallContext;
39
40 import javax.jcr.ImportUUIDBehavior;
41 import javax.jcr.RepositoryException;
42 import java.io.IOException;
43
44 /**
45 * Base class for tasks which bootstrap resources.
46 *
47 * @author gjoseph
48 * @version $Revision: $ ($Author: $)
49 */
50 public abstract class BootstrapResourcesTask extends AbstractTask {
51 private final int importUUIDBehavior;
52
53 public BootstrapResourcesTask(String name, String description) {
54 this(name, description, ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
55 }
56
57 public BootstrapResourcesTask(String name, String description, int importUUIDBehavior) {
58 super(name, description);
59 this.importUUIDBehavior = importUUIDBehavior;
60 }
61
62 // TODO : check if nodes were already there
63 @Override
64 public void execute(final InstallContext installContext) throws TaskExecutionException {
65 try {
66 final String[] resourcesToBootstrap = getResourcesToBootstrap(installContext);
67 BootstrapUtil.bootstrap(resourcesToBootstrap, importUUIDBehavior);
68 } catch (IOException e) {
69 throw new TaskExecutionException("Could not bootstrap: " + e.getMessage(), e);
70 } catch (RepositoryException e) {
71 throw new TaskExecutionException("Could not bootstrap: " + e.getMessage(), e);
72 }
73 }
74
75 /**
76 * Override this method to bootstrap specific resource files.
77 */
78 protected String[] getResourcesToBootstrap(final InstallContext installContext) {
79 String[] resourcesToBootstrap = ClasspathResourcesUtil.findResources(new ClasspathResourcesUtil.Filter() {
80 @Override
81 public boolean accept(final String name) {
82 return acceptResource(installContext, name);
83 }
84 });
85 return resourcesToBootstrap;
86
87 }
88
89 /**
90 * Override this method to filter resources to bootstrap.
91 */
92 protected boolean acceptResource(final InstallContext installContext, final String resourceName) {
93 return false;
94 }
95 }