/*
* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
* 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 Action
annotation allows explicit association of a
* WS-Addressing Action
message addressing property with
* input
, output
, and
* fault
messages of the mapped WSDL operation.
*
* 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
* wsam:Action
attribute on the WSDL input
,
* output
and fault
messages of the WSDL operation
* is based upon which attributes of the Action
annotation have been specified.
* For the exact computation of wsam:Action
values for the messages, refer
* to the algorithm in the JAX-WS specification.
*
* Example 1: Specify explicit values for Action
message addressing property
* for input
and output
messages.
*
*
* @WebService(targetNamespace="http://example.com/numbers") * public class AddNumbersImpl { * @Action( * input="http://example.com/inputAction", * output="http://example.com/outputAction") * public int addNumbers(int number1, int number2) { * return number1 + number2; * } * } ** * The generated WSDL looks like: *
* <definitions targetNamespace="http://example.com/numbers" ...> * ... * <portType name="AddNumbersPortType"> * <operation name="AddNumbers"> * <input message="tns:AddNumbersInput" name="foo" * wsam:Action="http://example.com/inputAction"/> * <output message="tns:AddNumbersOutput" name="bar" * wsam:Action="http://example.com/outputAction"/> * </operation> * </portType> * ... * </definitions> ** *
* Example 2: Specify explicit value for Action
message addressing property
* for only the input
message. The wsam:Action
values for the
* WSDL output
message are computed using the algorithm in the JAX-WS specification.
*
*
* @WebService(targetNamespace="http://example.com/numbers") * public class AddNumbersImpl { * @Action(input="http://example.com/inputAction") * public int addNumbers(int number1, int number2) { * return number1 + number2; * } * } ** * The generated WSDL looks like: *
* <definitions targetNamespace="http://example.com/numbers" ...> * ... * <portType name="AddNumbersPortType"> * <operation name="AddNumbers"> * <input message="tns:AddNumbersInput" name="foo" * wsam:Action="http://example.com/inputAction" /> * <output message="tns:AddNumbersOutput" name="bar" * wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbersResponse"/> * </operation> * </portType> * ... * </definitions> ** * It is legitimate to specify an explicit value for
Action
message addressing property for
* output
message only. In this case, wsam:Action
value for the
* WSDL input
message is computed using the algorithm in the JAX-WS specification.
*
*
* Example 3: See {@link FaultAction} annotation for an example of
* how to specify an explicit value for Action
message addressing property for the
* fault
message.
*
* @see FaultAction
*
* @since JAX-WS 2.1
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Action {
/**
* Explicit value of the WS-Addressing Action
message addressing property for the input
* message of the operation.
*/
String input() default "";
/**
* Explicit value of the WS-Addressing Action
message addressing property for the output
* message of the operation.
*/
String output() default "";
/**
* Explicit value of the WS-Addressing Action
message addressing property for the fault
* message(s) of the operation. Each exception that is mapped to a fault and requires an explicit WS-Addressing
* Action
message addressing property, needs to be specified as a value in this property
* using {@link FaultAction} annotation.
*/
FaultAction[] fault() default { };
}