View Javadoc
1   /**
2    * This file Copyright (c) 2003-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.virtualuri;
35  
36  import java.net.URI;
37  import java.util.Optional;
38  
39  /**
40   * VirtualUriMapping implementations are configured and loaded into the {@link VirtualUriRegistry};
41   * they are then used by the {@link VirtualUriFilter} to transform incoming URI requests.
42   */
43  public interface VirtualUriMapping {
44      /**
45       * Maps an incoming URI to a new target URI. The new URI can be prefixed with "redirect:", "permanent:" or "forward:" to trigger
46       * either a temporary redirect, a permanent redirect or a forward respectively. For redirects the URI can be
47       * absolute or relative within the web application (the context path is added automatically). If the mapping does
48       * not apply to the input URI this method returns null.
49       *
50       * @param uri a relative URI containing only the path and query components.
51       * The path is relative to the magnolia servlet mapping; context path is already stripped.
52       */
53      Optional<Result> mapUri(URI uri);
54  
55      /**
56       * Validate necessary info to check VirtualUriMapping is valid.
57       */
58      boolean isValid();
59  
60      /**
61       * Mapping information returned by {@link VirtualUriMapping#mapUri(URI)}.
62       */
63      class Result implements Comparable<Result> {
64          private String toUri;
65          private int weight;
66          private VirtualUriMapping mapping;
67  
68          public Result(String toUri, int weight, VirtualUriMapping mapping) {
69              this.toUri = toUri;
70              this.weight = weight;
71              this.mapping = mapping;
72          }
73  
74          public String getToUri() {
75              return toUri;
76          }
77  
78          /**
79           * Qualifies the matching (the length of the pattern or the groupCount from matcher). The best matching will win.
80           * It is used for comparison by the {@link VirtualUriFilter}.
81           * This is analog to {@link info.magnolia.cms.beans.config.VirtualURIMapping.MappingResult#getLevel()} in the old API.
82           */
83          public int getWeight() {
84              return weight;
85          }
86  
87          public VirtualUriMapping getMapping() {
88              return mapping;
89          }
90  
91          @Override
92          public int compareTo(Result o) {
93              return Integer.compare(getWeight(), o.getWeight());
94          }
95      }
96  }