001/*
002 * Copyright (c) 2004-2010, Kohsuke Kawaguchi
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification, are permitted provided
006 * that the following conditions are met:
007 *
008 *     * Redistributions of source code must retain the above copyright notice, this list of
009 *       conditions and the following disclaimer.
010 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
011 *       conditions and the following disclaimer in the documentation and/or other materials
012 *       provided with the distribution.
013 *
014 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
015 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
016 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
017 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
018 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
019 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
020 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
021 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
022 */
023
024package org.kohsuke.stapler;
025
026import java.lang.annotation.Documented;
027import static java.lang.annotation.ElementType.METHOD;
028import java.lang.annotation.Retention;
029import static java.lang.annotation.RetentionPolicy.RUNTIME;
030import java.lang.annotation.Target;
031
032/**
033 * Indicates that the method is bound to HTTP and used to
034 * serve the HTTP request.
035 *
036 * <p>
037 * This annotation is assumed to be implicit on every public methods
038 * that start with 'do', like 'doFoo' or 'doBar', but you can use this annotation
039 * on methods starting with {@code do} to assign different names.
040 *
041 * @author Kohsuke Kawaguchi
042 */
043@Retention(RUNTIME)
044@Target(METHOD)
045@Documented
046public @interface WebMethod {
047    /**
048     * URL names assigned to this method.
049     *
050     * <p>
051     * Normally, for <tt>doXyz</tt> method, the name is <tt>xyz</tt>,
052     * but you can use this to assign multiple names or non-default names.
053     * Often useful for using names that contain non-identifier characters.
054     */
055    String[] name();
056}