1. Project Clover database Fri Apr 29 2016 13:24:33 CEST
  2. Package info.magnolia.module.blossom.annotation

File VirtualURIMapper.java

 

Code metrics

0
0
0
1
69
9
0
-
-
0
-

Classes

Class Line # Actions
VirtualURIMapper 68 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2010-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.module.blossom.annotation;
35   
36    import java.lang.annotation.ElementType;
37    import java.lang.annotation.Retention;
38    import java.lang.annotation.RetentionPolicy;
39    import java.lang.annotation.Target;
40   
41    /**
42    * Used on a type to have all its methods that can be used as {@link info.magnolia.cms.beans.config.VirtualURIMapping}s
43    * exposed to Magnolia. Methods can return String or MappingResult and accept as arguments the incoming uri as a String
44    * and/or a HttpServletRequest. The returned URI can be prefixed with "redirect:", "permanent:" or "forward:" to trigger
45    * either a temporary redirect, a permanent redirect or a forward respectively. For redirects the URI can be absolute or
46    * relative within the web application (the context path is added automatically).
47    *
48    * For example:
49    * <pre>
50    * &#64;VirtualURIMapper
51    * public class ExampleUriMapper {
52    * public String about(String uri, HttpServletRequest request) {
53    * if (uri.equals("/about.html")) return "/sections/about";
54    * return null;
55    * }
56    * public String newsletter(String uri) {
57    * if (uri.equals("/newsletter.html")) return "redirect:/sections/newsletter.html";
58    * return null;
59    * }
60    * }
61    * </pre>
62    *
63    * @see info.magnolia.cms.beans.config.VirtualURIMapping
64    * @since 1.1.1
65    */
66    @Retention(value = RetentionPolicy.RUNTIME)
67    @Target(ElementType.TYPE)
 
68    public @interface VirtualURIMapper {
69    }