universe@6: /*
universe@6:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@34:  *
universe@24:  * Copyright 2018 Mike Becker. All rights reserved.
universe@34:  *
universe@6:  * Redistribution and use in source and binary forms, with or without
universe@6:  * modification, are permitted provided that the following conditions are met:
universe@6:  *
universe@6:  *   1. Redistributions of source code must retain the above copyright
universe@6:  *      notice, this list of conditions and the following disclaimer.
universe@6:  *
universe@6:  *   2. Redistributions in binary form must reproduce the above copyright
universe@6:  *      notice, this list of conditions and the following disclaimer in the
universe@6:  *      documentation and/or other materials provided with the distribution.
universe@6:  *
universe@6:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@6:  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@6:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@6:  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@6:  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@6:  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@6:  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@6:  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@6:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@6:  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@6:  * POSSIBILITY OF SUCH DAMAGE.
universe@34:  *
universe@6:  */
universe@6: package de.uapcore.lightpit;
universe@6: 
universe@34: import java.lang.annotation.*;
universe@6: 
universe@6: 
universe@6: /**
universe@11:  * Maps requests to methods.
universe@34:  * <p>
universe@11:  * This annotation is used to annotate methods within classes which
universe@11:  * override {@link AbstractLightPITServlet}.
universe@6:  */
universe@7: @Documented
universe@6: @Retention(RetentionPolicy.RUNTIME)
universe@11: @Target(ElementType.METHOD)
universe@11: public @interface RequestMapping {
universe@34: 
universe@7:     /**
universe@11:      * Specifies the HTTP method.
universe@34:      *
universe@11:      * @return the HTTP method handled by the annotated Java method
universe@7:      */
universe@11:     HttpMethod method();
universe@11: 
universe@11:     /**
universe@11:      * Specifies the request path relative to the module path.
universe@34:      * <p>
universe@11:      * If a menu key is specified, this is also the path, which is linked
universe@11:      * by the menu entry.
universe@34:      * <p>
universe@18:      * The path must be specified <em>without</em> leading and trailing slash.
universe@34:      *
universe@11:      * @return the request path the annotated method should handle
universe@11:      */
universe@11:     String requestPath() default "";
universe@34: 
universe@10:     /**
universe@45:      * Specifies the properties key for the sub menu label.
universe@45:      * An empty string (default) means that no sub menu entry shall be created.
universe@34:      * <p>
universe@11:      * This should only be used for {@link HttpMethod#GET} requests.
universe@34:      *
universe@11:      * @return the properties key
universe@10:      */
universe@11:     String menuKey() default "";
universe@45: 
universe@45:     /**
universe@45:      * May be changed to control the ordering of menu items.
universe@45:      *
universe@45:      * @return an integer to control the ordering
universe@45:      */
universe@45:     int menuSequence() default 0;
universe@6: }