1 /**
2 * This file Copyright (c) 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.admincentral;
35
36 import info.magnolia.cms.filters.ServletDispatchingFilter;
37 import info.magnolia.init.MagnoliaConfigurationProperties;
38 import info.magnolia.objectfactory.ComponentProvider;
39
40 import java.util.HashMap;
41 import java.util.Map;
42
43 import javax.inject.Inject;
44
45 import com.vaadin.server.Constants;
46
47 /**
48 * This {@link ServletDispatchingFilter} is responsible for Vaadin init-parameters `productionMode` and `resourceCacheTime`.
49 *
50 * <p>If `magnolia.develop` is `true` in {@linkplain info.magnolia.init.MagnoliaConfigurationProperties magnolia.properties},
51 * `productionMode` will be set to false, and `resourceCacheTime` will be set to 0.
52 *
53 * <p>If any of these parameters is configured under `/server/filters/servlets/<servlet-name>/parameters`,
54 * these configured parameters will be used.
55 */
56 public class VaadinServletDispatchingFilter extends ServletDispatchingFilter {
57 private final MagnoliaConfigurationProperties magnoliaProperties;
58
59 @Inject
60 public VaadinServletDispatchingFilter(ComponentProvider componentProvider, MagnoliaConfigurationProperties magnoliaProperties) {
61 super(componentProvider);
62 this.magnoliaProperties = magnoliaProperties;
63 }
64
65 @Override
66 public Map getParameters() {
67 // enrich parameters if magnolia.develop=true
68 Map<String, String> parameters = new HashMap<>();
69 if (magnoliaProperties.getBooleanProperty("magnolia.develop")) {
70 parameters.put(Constants.SERVLET_PARAMETER_PRODUCTION_MODE, "false");
71 parameters.put(Constants.SERVLET_PARAMETER_RESOURCE_CACHE_TIME, "0");
72 }
73 // give precedence to configured parameters
74 parameters.putAll(super.getParameters());
75 return parameters;
76 }
77 }