View Javadoc
1   /**
2    * This file Copyright (c) 2016 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.resourceloader.classpath.service.impl.base;
35  
36  import info.magnolia.resourceloader.classpath.hierarchy.ClasspathEntry;
37  import info.magnolia.resourceloader.classpath.service.impl.devmode.DevelopmentModeClasspathFile;
38  import info.magnolia.resourceloader.classpath.service.impl.legacy.LegacyClasspathFile;
39  import info.magnolia.resourceloader.classpath.service.impl.production.ProductionModeClasspathFile;
40  
41  import java.net.URL;
42  
43  import org.reflections.vfs.Vfs;
44  
45  /**
46   * Strategy class which helps to build {@linkplain ClasspathEntry classpath files} from some arbitrary context.
47   * <p>
48   * Provides three default implementations (based on {@link Vfs}) for dev, production and legacy modes.
49   */
50  public abstract class ClasspathFileConstructionStrategy {
51  
52      public abstract ClasspathEntry buildFile(Object... args);
53  
54      public static ClasspathFileConstructionStrategy productionWithVfs() {
55          return new ProductionModeConstructionStrategy();
56      }
57  
58      public static ClasspathFileConstructionStrategy legacyWithVfs() {
59          return new LegacyResourcesConstructionStrategy();
60      }
61  
62      public static ClasspathFileConstructionStrategy developmentModeWithVfs() {
63          return new DevelopmentModeConstructionStrategy();
64      }
65  
66      private static class ProductionModeConstructionStrategy extends ClasspathFileConstructionStrategy {
67          @Override
68          public ClasspathEntry buildFile(Object... args) {
69              if (!(args[0] instanceof Vfs.File)) {
70                  throw new IllegalStateException(String.format("Vfs.file has to be provided before %s construction", ProductionModeClasspathFile.class.getSimpleName()));
71              }
72              String relativePath = ((Vfs.File) args[0]).getRelativePath();
73              if (relativePath == null) {
74                  throw new IllegalStateException(String.format("Path has to be specified before %s construction", ProductionModeClasspathFile.class.getSimpleName()));
75              }
76  
77              return createClasspathEntry(relativePath);
78          }
79  
80          protected ProductionModeClasspathFile createClasspathEntry(String relativePath) {
81              return new ProductionModeClasspathFile(relativePath);
82          }
83      }
84  
85      private static class LegacyResourcesConstructionStrategy extends ProductionModeConstructionStrategy {
86          @Override
87          protected ProductionModeClasspathFile createClasspathEntry(String relativePath) {
88              return new LegacyClasspathFile(relativePath);
89          }
90      }
91  
92      private static class DevelopmentModeConstructionStrategy extends ClasspathFileConstructionStrategy {
93          @Override
94          public ClasspathEntry buildFile(Object... args) {
95              if (!(args[0] instanceof Vfs.File)) {
96                  throw new IllegalStateException(String.format("Vfs.file has to be provided before %s construction", DevelopmentModeClasspathFile.class.getSimpleName()));
97              }
98              if (!(args[1] instanceof URL)) {
99                  throw new IllegalStateException(String.format("Classpath location has to be specified before %s construction", DevelopmentModeClasspathFile.class.getSimpleName()));
100             }
101 
102             final Vfs.File jarFile = (Vfs.File) args[0];
103             final URL classpathLocation = (URL) args[1];
104             return new DevelopmentModeClasspathFile(classpathLocation, jarFile);
105         }
106     }
107 }