comparison: src/main/java/de/uapcore/lightpit/RequestMapping.java
src/main/java/de/uapcore/lightpit/RequestMapping.java
- changeset 179
- 623c340058f3
- parent 130
- 7ef369744fd1
equal
deleted
inserted
replaced
| 178:88207b860cba | 179:623c340058f3 |
|---|---|
| 1 /* | |
| 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
| 3 * | |
| 4 * Copyright 2018 Mike Becker. All rights reserved. | |
| 5 * | |
| 6 * Redistribution and use in source and binary forms, with or without | |
| 7 * modification, are permitted provided that the following conditions are met: | |
| 8 * | |
| 9 * 1. Redistributions of source code must retain the above copyright | |
| 10 * notice, this list of conditions and the following disclaimer. | |
| 11 * | |
| 12 * 2. Redistributions in binary form must reproduce the above copyright | |
| 13 * notice, this list of conditions and the following disclaimer in the | |
| 14 * documentation and/or other materials provided with the distribution. | |
| 15 * | |
| 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | |
| 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE | |
| 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | |
| 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | |
| 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | |
| 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | |
| 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
| 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
| 26 * POSSIBILITY OF SUCH DAMAGE. | |
| 27 * | |
| 28 */ | |
| 29 package de.uapcore.lightpit; | |
| 30 | |
| 31 import java.lang.annotation.*; | |
| 32 | |
| 33 | |
| 34 /** | |
| 35 * Maps requests to methods. | |
| 36 * <p> | |
| 37 * This annotation is used to annotate methods within classes which | |
| 38 * override {@link AbstractLightPITServlet}. | |
| 39 */ | |
| 40 @Documented | |
| 41 @Retention(RetentionPolicy.RUNTIME) | |
| 42 @Target(ElementType.METHOD) | |
| 43 public @interface RequestMapping { | |
| 44 | |
| 45 /** | |
| 46 * Specifies the HTTP method. | |
| 47 * | |
| 48 * @return the HTTP method handled by the annotated Java method | |
| 49 */ | |
| 50 HttpMethod method(); | |
| 51 | |
| 52 /** | |
| 53 * Specifies the request path relative to the module path. | |
| 54 * The trailing slash is important. | |
| 55 * A node may start with a dollar ($) sign. | |
| 56 * This part of the path is then treated as an path parameter. | |
| 57 * Path parameters can be obtained by including the {@link PathParameters} interface in the signature. | |
| 58 * | |
| 59 * @return the request path the annotated method should handle | |
| 60 */ | |
| 61 String requestPath() default "/"; | |
| 62 } |
