src/main/java/de/uapcore/lightpit/RequestMapping.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2018 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */
package de.uapcore.lightpit;

import java.lang.annotation.*;


/**
 * Maps requests to methods.
 * <p>
 * This annotation is used to annotate methods within classes which
 * override {@link AbstractLightPITServlet}.
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RequestMapping {

    /**
     * Specifies the HTTP method.
     *
     * @return the HTTP method handled by the annotated Java method
     */
    HttpMethod method();

    /**
     * Specifies the request path relative to the module path.
     * <p>
     * If a menu key is specified, this is also the path, which is linked
     * by the menu entry.
     * <p>
     * The path must be specified <em>without</em> leading and trailing slash.
     *
     * @return the request path the annotated method should handle
     */
    String requestPath() default "";

    /**
     * Specifies the properties key for the sub menu label.
     * An empty string (default) means that no sub menu entry shall be created.
     * <p>
     * This should only be used for {@link HttpMethod#GET} requests.
     *
     * @return the properties key
     */
    String menuKey() default "";

    /**
     * May be changed to control the ordering of menu items.
     *
     * @return an integer to control the ordering
     */
    int menuSequence() default 0;
}