1 /**
2 * This file Copyright (c) 2015-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;
35
36 import info.magnolia.resourceloader.ResourceOriginFactory;
37 import info.magnolia.resourceloader.classpath.service.impl.legacy.LegacyClasspathService;
38
39 import java.io.IOException;
40 import java.io.InputStream;
41
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44
45 import com.google.auto.factory.AutoFactory;
46 import com.google.auto.factory.Provided;
47
48 /**
49 * Exposes resources under the /mgnl-resources/ folder as if they were under the root path.
50 * See {@value #DOCU_LINK} for further details.
51 */
52 @AutoFactory(implementing = ResourceOriginFactory.class)
53 public class LegacyClasspathResourceOrigin extends ClasspathResourceOrigin {
54
55 private static final Logger log = LoggerFactory.getLogger(LegacyClasspathResourceOrigin.class);
56
57 private static final String DOCU_LINK = "https://documentation.magnolia-cms.com/display/DOCS/Resources";
58
59 public LegacyClasspathResourceOrigin(String name, @Provided LegacyClasspathService service) {
60 super(name, service);
61 }
62
63 @Override
64 protected InputStream doOpenStream(ClasspathResource resource) throws IOException {
65 log.warn("Loading contents of a resource at [/mgnl-resources{}] via legacy {}. Please update your resources. For further details see {}", resource.getPath(), getClass().getSimpleName(), DOCU_LINK);
66 return super.doOpenStream(resource);
67 }
68 }