1 /**
2 * This file Copyright (c) 2017 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.virtualuri.compatibility;
35
36 import info.magnolia.cms.beans.config.QueryAwareVirtualURIMapping;
37 import info.magnolia.virtualuri.VirtualUriMapping;
38
39 import java.net.URI;
40 import java.util.Optional;
41
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44
45 /**
46 * Compatibility wrapper for old {@link info.magnolia.cms.beans.config.VirtualURIMapping VirtualURIMapping}, exposing it as the new type.
47 *
48 * @deprecated since 5.5.6, use {@link VirtualUriMapping} instead.
49 */
50 @Deprecated
51 public class VirtualUriMappingAdapter implements VirtualUriMapping {
52 private static final Logger log = LoggerFactory.getLogger(VirtualUriMappingAdapter.class);
53
54 private final info.magnolia.cms.beans.config.VirtualURIMapping oldMapping;
55
56 public VirtualUriMappingAdapter(info.magnolia.cms.beans.config.VirtualURIMapping oldMapping) {
57 this.oldMapping = oldMapping;
58 }
59
60 @Override
61 public Optional<Result> mapUri(URI uri) {
62 info.magnolia.cms.beans.config.VirtualURIMapping.MappingResult oldResult = null;
63
64 // Currently, try catch for ensure no NPE throws out, rely all the old virtual uri's implementation for checking NPE
65 try {
66 if (uri.getQuery() != null && oldMapping instanceof QueryAwareVirtualURIMapping) {
67 oldResult = ((QueryAwareVirtualURIMapping) oldMapping).mapURI(uri.getPath(), uri.getQuery());
68 } else {
69 oldResult = oldMapping.mapURI(uri.getPath());
70 }
71 } catch (NullPointerException e) {
72 log.warn("Config for VirtualUriMapping {} is incomplete. Skipping URI mapping.", oldMapping);
73 }
74
75 if (oldResult == null) {
76 return Optional.empty();
77 }
78
79 String targetUri = oldResult.getToURI();
80 Result result = new Result(targetUri, oldResult.getLevel(), this);
81 return Optional.of(result);
82 }
83
84 @Override
85 public boolean isValid() {
86 return oldMapping.isValid();
87 }
88
89 public info.magnolia.cms.beans.config.VirtualURIMapping asOldMapping() {
90 return oldMapping;
91 }
92
93 @Override
94 public String toString() {
95 return oldMapping.toString();
96 }
97 }