View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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 {@link info.magnolia.cms.filters.VirtualUriFilter}
38   * to transform incoming uri requests.
39   * 
40   * @author philipp
41   * @version $Id: VirtualURIMapping.java 36178 2010-08-03 16:34:52Z gjoseph $
42   *
43   * @content2bean.component path="/modules/.../virtualURIMapping"
44   */
45  public interface VirtualURIMapping {
46      public MappingResult mapURI(String uri);
47  
48      public static class MappingResult{
49          private String toURI;
50          private int level;
51  
52          public int getLevel() {
53              return this.level;
54          }
55  
56          public void setLevel(int level) {
57              this.level = level;
58          }
59  
60          public String getToURI() {
61              return this.toURI;
62          }
63  
64          public void setToURI(String toURI) {
65              this.toURI = toURI;
66          }
67      }
68  }