View Javadoc
1   /**
2    * This file Copyright (c) 2003-2017 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.importexport.command.JcrExportCommand;
39  import info.magnolia.module.InstallContext;
40  
41  import java.io.IOException;
42  
43  import javax.jcr.ImportUUIDBehavior;
44  import javax.jcr.RepositoryException;
45  
46  import org.apache.commons.io.FilenameUtils;
47  
48  /**
49   * Base class for tasks which bootstrap resources.
50   */
51  public abstract class BootstrapResourcesTask extends AbstractTask {
52      private final int importUUIDBehavior;
53  
54      public BootstrapResourcesTask() {
55          this("Bootstrap module resources", "Bootstraps module resources", ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
56      }
57  
58      public BootstrapResourcesTask(int importUUIDBehavior) {
59          this("Bootstrap module resources", "Bootstraps module resources", importUUIDBehavior);
60      }
61  
62      public BootstrapResourcesTask(String name, String description) {
63          this(name, description, ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
64      }
65  
66      public BootstrapResourcesTask(String name, String description, int importUUIDBehavior) {
67          super(name, description);
68          this.importUUIDBehavior = importUUIDBehavior;
69      }
70  
71      @Override
72      public void execute(final InstallContext installContext) throws TaskExecutionException {
73          try {
74              bootstrap(installContext, importUUIDBehavior);
75          } catch (IOException | RepositoryException e) {
76              throw new TaskExecutionException("Could not bootstrap: " + e.getMessage(), e);
77          }
78      }
79  
80      protected void bootstrap(InstallContext installContext, int importUUIDBehavior) throws IOException, RepositoryException {
81          final String[] resourcesToBootstrap = getResourcesToBootstrap(installContext);
82          BootstrapUtil.bootstrap(resourcesToBootstrap, this.importUUIDBehavior);
83      }
84  
85      /**
86       * Override this method to bootstrap specific resource files.
87       */
88      protected String[] getResourcesToBootstrap(final InstallContext installContext) {
89          String[] resourcesToBootstrap = ClasspathResourcesUtil.findResources(new ClasspathResourcesUtil.Filter() {
90              @Override
91              public boolean accept(final String name) {
92                  return acceptResource(installContext, name);
93              }
94          });
95          return resourcesToBootstrap;
96  
97      }
98  
99      /**
100      * Override this method to filter resources to bootstrap.
101      */
102     protected boolean acceptResource(final InstallContext installContext, final String resourceName) {
103         return JcrExportCommand.Format.isSupportedExtension(FilenameUtils.getExtension(resourceName));
104     }
105 }