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.production;
35  
36  import info.magnolia.resourceloader.classpath.hierarchy.ClasspathFile;
37  
38  import java.io.IOException;
39  import java.io.InputStream;
40  import java.net.URL;
41  
42  import org.apache.commons.lang3.StringUtils;
43  import org.reflections.util.ClasspathHelper;
44  import org.slf4j.Logger;
45  import org.slf4j.LoggerFactory;
46  
47  import com.google.common.base.Objects;
48  
49  /**
50   * {@link ClasspathFile} implementation oriented onto <strong>production application mode</strong>.
51   *
52   * <p>Communicates to the actual file via context {@link ClassLoader class loader}.</p>
53   */
54  public class ProductionModeClasspathFile implements ClasspathFile {
55  
56      private static final Logger log = LoggerFactory.getLogger(ProductionModeClasspathFile.class);
57  
58      private String classLoaderCompliantPath;
59  
60      private URL classpathUrl = null;
61  
62      public ProductionModeClasspathFile(String classLoaderCompliantPath) {
63          this.classLoaderCompliantPath = classLoaderCompliantPath;
64      }
65  
66      @Override
67      public String getName() {
68          return StringUtils.substringAfterLast(getAbsolutePath(), "/");
69      }
70  
71      @Override
72      public String getAbsolutePath() {
73          return "/" + classLoaderCompliantPath;
74      }
75  
76      @Override
77      public InputStream openStream() throws IOException {
78          return getUrl().openStream();
79      }
80  
81      @Override
82      public long getLastModified() {
83          try {
84              return getUrl().openConnection().getLastModified();
85          } catch (IOException e) {
86              log.warn("Failed to check the last modification date of a resource at [{}]: {}. Returning -1", getAbsolutePath(), e.getMessage());
87              return -1;
88          }
89      }
90  
91      protected final URL getUrl() {
92          if (classpathUrl == null) {
93              classpathUrl = resolveUrl();
94          }
95          return classpathUrl;
96      }
97  
98      protected final URL resolveUrl() {
99          final URL resourceUrl = ClasspathHelper.contextClassLoader().getResource(classLoaderCompliantPath);
100         if (resourceUrl == null) {
101             throw new IllegalStateException(String.format("Failed to obtain resource URL at [%s] via context class loader, probably such resource does not exist...", this.classLoaderCompliantPath));
102         }
103         return this.classpathUrl = resourceUrl;
104     }
105 
106     @Override
107     public boolean equals(Object o) {
108         if (this == o) return true;
109         if (o == null || getClass() != o.getClass()) return false;
110 
111         ProductionModeClasspathFile that = (ProductionModeClasspathFile) o;
112 
113         return Objects.equal(getAbsolutePath(), that.getAbsolutePath());
114     }
115 
116     @Override
117     public int hashCode() {
118         return Objects.hashCode(getAbsolutePath());
119     }
120 }