1 /** 2 * This file Copyright (c) 2003-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.cms.beans.config; 35 36 /** 37 * VirtualURIMapping implementations are used by {@link info.magnolia.cms.beans.config.VirtualURIManager} and 38 * {@link info.magnolia.cms.filters.VirtualUriFilter} to transform incoming URI requests. 39 * 40 * @content2bean.component path="/modules/.../virtualURIMapping" 41 */ 42 public interface VirtualURIMapping { 43 44 /** 45 * Maps an incoming URI to a new target URI. Returns a {@link VirtualURIMapping.MappingResult} describing the new 46 * URI and the level of match. The new URI can be prefixed with "redirect:", "permanent:" or "forward:" to trigger 47 * either a temporary redirect, a permanent redirect or a forward respectively. For redirects the URI can be 48 * absolute or relative within the web application (the context path is added automatically). If the mapping does 49 * not apply to the input URI this method returns null. 50 * 51 * @param uri the URI of the current request, decoded and without the context path 52 * @return a {@link VirtualURIMapping.MappingResult} with the target URI and level or null if the mapping doesn't apply 53 */ 54 MappingResult mapURI(String uri); 55 56 /** 57 * Mapping information returned by {@link VirtualURIMapping#mapURI(String)}. 58 */ 59 public static class MappingResult { 60 61 private String toURI; 62 63 /** 64 * Qualifies the matching (the length of the pattern). The best matching will win. 65 */ 66 private int level; 67 68 public int getLevel() { 69 return this.level; 70 } 71 72 public void setLevel(int level) { 73 this.level = level; 74 } 75 76 public String getToURI() { 77 return this.toURI; 78 } 79 80 public void setToURI(String toURI) { 81 this.toURI = toURI; 82 } 83 } 84 }