View Javadoc

1   /**
2    * This file Copyright (c) 2009-2013 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.module.InstallContext;
37  
38  import javax.jcr.ImportUUIDBehavior;
39  
40  /**
41   * Bootstraps a classpath resources relative to the module's bootstrap folder: /mgnl-bootstrap/<module-name>>.
42   */
43  public class BootstrapSingleModuleResource extends BootstrapResourcesTask {
44      private final String resourceName;
45  
46      public BootstrapSingleModuleResource(String resourceName) {
47          this(resourceName, ImportUUIDBehavior.IMPORT_UUID_COLLISION_THROW);
48      }
49  
50      public BootstrapSingleModuleResource(String resourceName, int importUUIDBehavior) {
51          this("Bootstrap resource", String.format("Bootstraps module resource '%s' from '/mgnl-bootstrap/' folder.", resourceName), resourceName, importUUIDBehavior);
52      }
53  
54      public BootstrapSingleModuleResource(String name, String description, String resourceName) {
55          super(name, description);
56          this.resourceName = resourceName;
57      }
58  
59      public BootstrapSingleModuleResource(String name, String description, String resourceName, int importUUIDBehavior) {
60          super(name, description, importUUIDBehavior);
61          this.resourceName = resourceName;
62      }
63  
64      @Override
65      protected String[] getResourcesToBootstrap(final InstallContext installContext) {
66          return new String[]{"/mgnl-bootstrap/"+installContext.getCurrentModuleDefinition().getName()+"/"+resourceName};
67      }
68  
69  }