Sun, 10 May 2020 10:11:37 +0200
removes features that are not (and probably will not) used anyway
universe@6 | 1 | /* |
universe@6 | 2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
universe@34 | 3 | * |
universe@24 | 4 | * Copyright 2018 Mike Becker. All rights reserved. |
universe@34 | 5 | * |
universe@6 | 6 | * Redistribution and use in source and binary forms, with or without |
universe@6 | 7 | * modification, are permitted provided that the following conditions are met: |
universe@6 | 8 | * |
universe@6 | 9 | * 1. Redistributions of source code must retain the above copyright |
universe@6 | 10 | * notice, this list of conditions and the following disclaimer. |
universe@6 | 11 | * |
universe@6 | 12 | * 2. Redistributions in binary form must reproduce the above copyright |
universe@6 | 13 | * notice, this list of conditions and the following disclaimer in the |
universe@6 | 14 | * documentation and/or other materials provided with the distribution. |
universe@6 | 15 | * |
universe@6 | 16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
universe@6 | 17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
universe@6 | 18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
universe@6 | 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
universe@6 | 20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
universe@6 | 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
universe@6 | 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
universe@6 | 23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
universe@6 | 24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
universe@6 | 25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
universe@6 | 26 | * POSSIBILITY OF SUCH DAMAGE. |
universe@34 | 27 | * |
universe@6 | 28 | */ |
universe@6 | 29 | package de.uapcore.lightpit; |
universe@6 | 30 | |
universe@34 | 31 | import java.lang.annotation.*; |
universe@6 | 32 | |
universe@6 | 33 | |
universe@6 | 34 | /** |
universe@11 | 35 | * Maps requests to methods. |
universe@34 | 36 | * <p> |
universe@11 | 37 | * This annotation is used to annotate methods within classes which |
universe@11 | 38 | * override {@link AbstractLightPITServlet}. |
universe@6 | 39 | */ |
universe@7 | 40 | @Documented |
universe@6 | 41 | @Retention(RetentionPolicy.RUNTIME) |
universe@11 | 42 | @Target(ElementType.METHOD) |
universe@11 | 43 | public @interface RequestMapping { |
universe@34 | 44 | |
universe@7 | 45 | /** |
universe@11 | 46 | * Specifies the HTTP method. |
universe@34 | 47 | * |
universe@11 | 48 | * @return the HTTP method handled by the annotated Java method |
universe@7 | 49 | */ |
universe@11 | 50 | HttpMethod method(); |
universe@11 | 51 | |
universe@11 | 52 | /** |
universe@11 | 53 | * Specifies the request path relative to the module path. |
universe@34 | 54 | * <p> |
universe@11 | 55 | * If a menu key is specified, this is also the path, which is linked |
universe@11 | 56 | * by the menu entry. |
universe@34 | 57 | * <p> |
universe@18 | 58 | * The path must be specified <em>without</em> leading and trailing slash. |
universe@34 | 59 | * |
universe@11 | 60 | * @return the request path the annotated method should handle |
universe@11 | 61 | */ |
universe@11 | 62 | String requestPath() default ""; |
universe@34 | 63 | |
universe@10 | 64 | /** |
universe@11 | 65 | * Returns the properties key for the (sub) menu label. |
universe@34 | 66 | * <p> |
universe@11 | 67 | * This should only be used for {@link HttpMethod#GET} requests. |
universe@34 | 68 | * |
universe@11 | 69 | * @return the properties key |
universe@10 | 70 | */ |
universe@11 | 71 | String menuKey() default ""; |
universe@6 | 72 | } |