1 /**
2 * This file Copyright (c) 2016-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.resourceloader.classpath.service;
35
36 import java.net.URL;
37 import java.nio.charset.Charset;
38 import java.util.function.Predicate;
39 import java.util.regex.Pattern;
40
41 /**
42 * Aggregates common properties which allow to narrow the classpath resource search scope, distinguish meaningful
43 * classpath resources from the insignificant ones etc.
44 */
45 public interface ClasspathServiceConfiguration {
46
47 /**
48 * Get possible classpath locations to search resources at (e.g. typically - URLs of the jar libraries in WEB-INF/lib folder).
49 */
50 Iterable<URL> getClasspathLocations();
51
52 /**
53 * Get a {@link Predicate} which would based on the given classpath resource path deduce whether that is
54 * actually a meaningful resource.
55 */
56 Predicate<String> getResourceFilter();
57
58 /**
59 * Get the charset to be used to access the contents of the textual classpath resources.
60 */
61 Charset getCharset();
62
63 /**
64 * Get a resource path pattern which would match the classpath resources that must be considered during
65 * classpath monitoring.
66 *
67 * @see MonitoredClasspathService
68 */
69 Pattern getMonitoredResourcePattern();
70 }