/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.xml.ws;

import java.lang.annotation.Documented;

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

/**

 * The <code>Action</code> annotation allows explicit association of a

 * WS-Addressing <code>Action</code> message addressing property with

 * <code>input</code>, <code>output</code>, and

 * <code>fault</code> messages of the mapped WSDL operation.

 * <p>

 * This annotation can be specified on each method of a service endpoint interface.

 * For such a method, the mapped operation in the generated WSDL's

 * <code>wsam:Action</code> attribute on the WSDL <code>input</code>,

 * <code>output</code> and <code>fault</code> messages of the WSDL <code>operation</code>

 * is based upon which attributes of the <code>Action</code> annotation have been specified.

 * For the exact computation of <code>wsam:Action</code> values for the messages, refer

 * to the algorithm in the JAX-WS specification.

 * <p>

 * <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing property

 * for <code>input</code> and <code>output</code> messages.

 *

 * <pre>

 * @WebService(targetNamespace="http://example.com/numbers")

 * public class AddNumbersImpl {

 *     <b>&#64;Action(

 *         input="http://example.com/inputAction",

 *         output="http://example.com/outputAction")</b>

 *     public int addNumbers(int number1, int number2) {

 *         return number1 + number2;

 *     }

 * }

 * </pre>

 *

 * The generated WSDL looks like:

 * <pre>

 *   <definitions targetNamespace="http://example.com/numbers" ...>

 *     ...

 *     <portType name="AddNumbersPortType">

 *       <operation name="AddNumbers">

 *         <input message="tns:AddNumbersInput" name="foo"

 *           <b>wsam:Action="http://example.com/inputAction"</b>/>

 *         <output message="tns:AddNumbersOutput" name="bar"

 *           <b>wsam:Action="http://example.com/outputAction"</b>/>

 *       </operation>

 *     </portType>

 *     ...

 *   </definitions>

 * </pre>

 *

 * <p>

 * <b>Example 2</b>: Specify explicit value for <code>Action</code> message addressing property

 * for only the <code>input</code> message. The <code>wsam:Action</code> values for the

 * WSDL <code>output</code> message are computed using the algorithm in the JAX-WS specification.

 *

 * <pre>

 * @WebService(targetNamespace="http://example.com/numbers")

 * public class AddNumbersImpl {

 *     <b>&#64;Action(input="http://example.com/inputAction")</b>

 *     public int addNumbers(int number1, int number2) {

 *         return number1 + number2;

 *     }

 * }

 * </pre>

 *

 * The generated WSDL looks like:

 * <pre>

 *   <definitions targetNamespace="http://example.com/numbers" ...>

 *     ...

 *     <portType name="AddNumbersPortType">

 *       <operation name="AddNumbers">

 *         <input message="tns:AddNumbersInput" name="foo"

 *           <b>wsam:Action="http://example.com/inputAction"</b> />

 *         <output message="tns:AddNumbersOutput" name="bar"

 *           <b>wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbersResponse"</b>/>

 *       </operation>

 *     </portType>

 *     ...

 *   </definitions>

 * </pre>

 *

 * It is legitimate to specify an explicit value for <code>Action</code> message addressing property for

 * <code>output</code> message only. In this case, <code>wsam:Action</code> value for the

 * WSDL <code>input</code> message is computed using the algorithm in the JAX-WS specification.

 *

 * <p>

 * <b>Example 3</b>: See {@link FaultAction} annotation for an example of

 * how to specify an explicit value for <code>Action</code> message addressing property for the

 * <code>fault</code> message.

 *

 * @see FaultAction

 *

 * @since JAX-WS 2.1

 */

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

public @interface Action {

    /**

     * Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>input</code>

     * message of the operation.

     */

    String input() default "";

    /**

     * Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>output</code>

     * message of the operation.

     */

    String output() default "";

    /**

     * Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>fault</code>

     * message(s) of the operation. Each exception that is mapped to a fault and requires an explicit WS-Addressing

     * <code>Action</code> message addressing property, needs to be specified as a value in this property

     * using {@link FaultAction} annotation.

     */

    FaultAction[] fault() default { };

}