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;
35  
36  import info.magnolia.resourceloader.classpath.hierarchy.ClasspathDirectory;
37  import info.magnolia.resourceloader.classpath.hierarchy.ClasspathEntry;
38  
39  /**
40   * Organises classpath resources into a hierarchical structure based on {@link ClasspathEntry} objects and
41   * provides convenient access to it.
42   */
43  public interface ClasspathService {
44  
45      /**
46       * Get configuration of the current {@link ClasspathService service}.
47       */
48      ClasspathServiceConfiguration getConfiguration();
49  
50      /**
51       * Get the root directory of the current service classpath hierarchy structure. Its path normally equals to {@code /}.
52       * @return root classpath directory
53       */
54      ClasspathDirectory getRoot();
55  
56      /**
57       * Get parent directory of a {@link ClasspathEntry classpath entry}.
58       */
59      ClasspathDirectory getParent(ClasspathEntry classpathEntry);
60  
61      /**
62       * Get {@link ClasspathEntry classpath entry} corresponding to a given path.
63       * @param path absolute path of a classpath entry
64       * @return resolved {@link ClasspathEntry} object
65       */
66      ClasspathEntry getEntryAt(String path);
67  
68      /**
69       * Check whether current service classpath structure contains an {@link ClasspathEntry entry}
70       * which corresponds to a given path.
71       */
72      boolean hasEntry(String path);
73  
74      /**
75       * Thrown when an attempt to resolve a {@link ClasspathEntry} by a path fails.
76       */
77      class ClasspathEntryNotFoundException extends RuntimeException {
78  
79          public ClasspathEntryNotFoundException(String path) {
80              super(String.format("Classpath entry at [%s] cannot be resolved", path));
81          }
82      }
83  }