1 /**
2 * This file Copyright (c) 2015-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;
35
36 import info.magnolia.resourceloader.classpath.ClasspathResourceOriginFactory;
37 import info.magnolia.resourceloader.classpath.LegacyClasspathResourceOriginFactory;
38 import info.magnolia.resourceloader.file.FileSystemResourceOriginFactory;
39 import info.magnolia.resourceloader.jcr.JcrResourceOriginFactory;
40 import info.magnolia.resourceloader.layered.LayeredResourceOrigin;
41 import info.magnolia.resourceloader.layered.LayeredResourceOriginFactory;
42
43 import java.util.Arrays;
44 import java.util.stream.Stream;
45
46 import javax.inject.Inject;
47 import javax.inject.Provider;
48 import javax.inject.Singleton;
49
50 /**
51 * With the help of this provider, one can {@code @Inject ResourceOrigin} in their code. It creates the default
52 * Magnolia stack of {@link ResourceOrigin}s; users can expect to get a predictable "stack" of origin implementations to load
53 * {@link Resource}s from.
54 */
55 @Singleton
56 public class DefaultResourceOrigins implements Provider<LayeredResourceOrigin> {
57
58 private final LayeredResourceOrigin layeredResourceOrigin;
59 private final ResourceOrigin[] resourceOrigins;
60
61 /**
62 * See note in {@link ResourceOriginFactory} about why we can't use @Multibinding at the moment.
63 */
64 @Inject
65 public DefaultResourceOrigins(ClasspathResourceOriginFactory classpathOriginFactory,
66 LegacyClasspathResourceOriginFactory legacyClasspathOriginFactory,
67 FileSystemResourceOriginFactory fileSystemOriginFactory,
68 JcrResourceOriginFactory jcrOriginFactory,
69 LayeredResourceOriginFactory layeredOriginFactory) {
70
71 this.resourceOrigins = new ResourceOrigin[] {
72 jcrOriginFactory.create("jcr"),
73 fileSystemOriginFactory.create("filesystem"),
74 legacyClasspathOriginFactory.create("classpath-legacy"),
75 classpathOriginFactory.create("classpath")
76 };
77
78 layeredResourceOrigin = layeredOriginFactory.create("layered", resourceOrigins);
79 }
80
81 public Stream<ResourceOrigin> getAvailableOrigins() {
82 return Arrays.stream(resourceOrigins);
83 }
84
85 @Override
86 public LayeredResourceOrigin get() {
87 return layeredResourceOrigin;
88 }
89 }