/*
* 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 FaultAction
annotation is used inside an {@link Action}
* annotation to allow an explicit association of a WS-Addressing
* Action
message addressing property with the fault
* messages of the WSDL operation mapped from the exception class.
*
* The wsam:Action
attribute value in the fault
* message in the generated WSDL operation mapped for className
* class is equal to the corresponding value in the FaultAction
.
* For the exact computation of wsam:Action
values for the
* fault messages, refer to the algorithm in the JAX-WS specification.
*
*
* Example 1: Specify explicit values for Action
message addressing
* property for the input
, output
and fault
message
* if the Java method throws only one service specific exception.
*
*
* @WebService(targetNamespace="http://example.com/numbers") * public class AddNumbersImpl { * @Action( * fault = { * @FaultAction(className=AddNumbersException.class, value="http://example.com/faultAction") * }) * public int addNumbers(int number1, int number2) * throws AddNumbersException { * return number1 + number2; * } * } ** * The generated WSDL looks like: * *
* <definitions targetNamespace="http://example.com/numbers" ...> * ... * <portType name="AddNumbersPortType"> * <operation name="AddNumbers"> * ... * <fault message="tns:AddNumbersException" name="AddNumbersException" * wsam:Action="http://example.com/faultAction"/> * </operation> * </portType> * ... * </definitions> ** *
* Example 2: Here is an example that shows if the explicit value for Action
* message addressing property for the service specific exception is not present.
*
*
* @WebService(targetNamespace="http://example.com/numbers") * public class AddNumbersImpl { * public int addNumbers(int number1, int number2) * throws AddNumbersException { * return number1 + number2; * } * } ** * The generated WSDL looks like: * *
* <definitions targetNamespace="http://example.com/numbers" ...> * ... * <portType name="AddNumbersPortType"> * <operation name="AddNumbers"> * ... * <fault message="tns:addNumbersFault" name="InvalidNumbers" * wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbers/Fault/AddNumbersException"/> * </operation> * </portType> * ... * </definitions> ** *
* Example 3: Here is an example that shows how to specify explicit values for Action
* message addressing property if the Java method throws more than one service specific exception.
*
*
* @WebService(targetNamespace="http://example.com/numbers") * public class AddNumbersImpl { * @Action( * fault = { * @FaultAction(className=AddNumbersException.class, value="http://example.com/addFaultAction"), * @FaultAction(className=TooBigNumbersException.class, value="http://example.com/toobigFaultAction") * }) * public int addNumbers(int number1, int number2) * throws AddNumbersException, TooBigNumbersException { * return number1 + number2; * } * } ** * The generated WSDL looks like: * *
* <definitions targetNamespace="http://example.com/numbers" ...> * ... * <portType name="AddNumbersPortType"> * <operation name="AddNumbers"> * ... * <fault message="tns:addNumbersFault" name="AddNumbersException" * wsam:Action="http://example.com/addFaultAction"/> * <fault message="tns:tooBigNumbersFault" name="TooBigNumbersException" * wsam:Action="http://example.com/toobigFaultAction"/> * </operation> * </portType> * ... * </definitions> ** * @since JAX-WS 2.1 */ @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface FaultAction { /** * Name of the exception class */ Class extends Exception> className(); /** * Value of WS-Addressing
Action
message addressing property for the exception
*/
String value() default "";
}