1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/main/java/de/uapcore/lightpit/RequestMapping.java Sat May 09 14:26:31 2020 +0200
1.3 @@ -0,0 +1,76 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2018 Mike Becker. All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + *
1.31 + */
1.32 +package de.uapcore.lightpit;
1.33 +
1.34 +import java.lang.annotation.Documented;
1.35 +import java.lang.annotation.ElementType;
1.36 +import java.lang.annotation.Retention;
1.37 +import java.lang.annotation.RetentionPolicy;
1.38 +import java.lang.annotation.Target;
1.39 +
1.40 +
1.41 +/**
1.42 + * Maps requests to methods.
1.43 + *
1.44 + * This annotation is used to annotate methods within classes which
1.45 + * override {@link AbstractLightPITServlet}.
1.46 + */
1.47 +@Documented
1.48 +@Retention(RetentionPolicy.RUNTIME)
1.49 +@Target(ElementType.METHOD)
1.50 +public @interface RequestMapping {
1.51 +
1.52 + /**
1.53 + * Specifies the HTTP method.
1.54 + *
1.55 + * @return the HTTP method handled by the annotated Java method
1.56 + */
1.57 + HttpMethod method();
1.58 +
1.59 + /**
1.60 + * Specifies the request path relative to the module path.
1.61 + *
1.62 + * If a menu key is specified, this is also the path, which is linked
1.63 + * by the menu entry.
1.64 + *
1.65 + * The path must be specified <em>without</em> leading and trailing slash.
1.66 + *
1.67 + * @return the request path the annotated method should handle
1.68 + */
1.69 + String requestPath() default "";
1.70 +
1.71 + /**
1.72 + * Returns the properties key for the (sub) menu label.
1.73 + *
1.74 + * This should only be used for {@link HttpMethod#GET} requests.
1.75 + *
1.76 + * @return the properties key
1.77 + */
1.78 + String menuKey() default "";
1.79 +}
