View Javadoc
1   /**
2    * This file Copyright (c) 2009-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.ImportUUIDBehavior;
42  import javax.jcr.RepositoryException;
43  
44  /**
45   * Bootstraps a classpath resources relative to the module's bootstrap folder: /mgnl-bootstrap/<module-name>>.
46   */
47  public class BootstrapSingleModuleResource extends BootstrapResourcesTask {
48  
49      private String subPath;
50      private final String resourceName;
51  
52      public BootstrapSingleModuleResource(String resourceName) {
53          this(resourceName, ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
54      }
55  
56      public BootstrapSingleModuleResource(String resourceName, int importUUIDBehavior) {
57          this("Bootstrap resource", String.format("Bootstraps module resource '%s' from '/mgnl-bootstrap/' folder.", resourceName), resourceName, importUUIDBehavior);
58      }
59  
60      public BootstrapSingleModuleResource(String name, String description, String resourceName) {
61          this(name, description, resourceName, ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
62      }
63  
64      public BootstrapSingleModuleResource(String name, String description, String resourceName, int importUUIDBehavior) {
65          super(name, description, importUUIDBehavior);
66          this.resourceName = resourceName;
67      }
68  
69      public BootstrapSingleModuleResource(String name, String description, String resourceName, String subPath) {
70          super(name, description, ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
71          this.resourceName = resourceName;
72          this.subPath = subPath;
73      }
74  
75      @Override
76      public void bootstrap(final InstallContext installContext, int importUUIDBehavior) throws IOException, RepositoryException {
77          BootstrapUtil.bootstrap(getResourcesToBootstrap(installContext)[0], subPath, importUUIDBehavior);
78      }
79  
80      @Override
81      protected String[] getResourcesToBootstrap(final InstallContext installContext) {
82          return new String[]{"/mgnl-bootstrap/" + installContext.getCurrentModuleDefinition().getName() + "/" + resourceName};
83      }
84  
85  }