JAX-WS
v2.1

javax.xml.ws
Annotation Type FaultAction


@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface FaultAction

The FaultAction annotation is used inside an Action annotation to allow an explicit association of Action message addressing property with the fault messages of the WSDL operation mapped from the exception class.

The fault message in the generated WSDL operation mapped for className class contains explicit wsaw:Action attribute.

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.

 @javax.jws.WebService
 public class AddNumbersImpl {
     @javax.xml.ws.Action(
         input="http://example.com/inputAction",
         output="http://example.com/outputAction",
         fault = {
             @javax.xml.ws.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">
         <input message="tns:AddNumbersInput" name="Parameters"
           wsaw:Action="http://example.com/inputAction"/>
        <output message="tns:AddNumbersOutput" name="Result"
          wsaw:Action="http://example.com/outputAction"/>
        <fault message="tns:AddNumbersException" name="AddNumbersException"
          wsaw:Action="http://example.com/faultAction"/>
       </operation>
     <portType>
   ...
   <definitions>
 

Example 2: Here is an example that shows how to specify explicit values for Action message addressing property if the Java method throws only one service specific exception, without specifying the values for input and output messages.

 @javax.jws.WebService
 public class AddNumbersImpl {
     @javax.xml.ws.Action(
         fault = {
             @javax.xml.ws.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">
         <input message="tns:AddNumbersInput" name="Parameters"/>
         <output message="tns:AddNumbersOutput" name="Result"/>
         <fault message="tns:addNumbersFault" name="InvalidNumbers"
           wsa:Action="http://example.com/addnumbers/fault"/>
       </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.

 @javax.jws.WebService
 public class AddNumbersImpl {
     @javax.xml.ws.Action(
         fault = {
             @javax.xml.ws.FaultAction(className=AddNumbersException.class, value="http://example.com/addFaultAction")
             @javax.xml.ws.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">
         <input message="tns:AddNumbersInput" name="Parameters"/>
         <output message="tns:AddNumbersOutput" name="Result"/>
         <fault message="tns:addNumbersFault" name="AddNumbersException"
           wsa:Action="http://example.com/addnumbers/fault"/>
         <fault message="tns:tooBigNumbersFault" name="TooBigNumbersException"
           wsa:Action="http://example.com/toobigFaultAction"/>
       </operation>
     <portType>
   ...
   <definitions>
 

Since:
JAX-WS 2.1

Required Element Summary
 java.lang.Class className
          Name of the exception class
 
Optional Element Summary
 java.lang.String value
          Value of Action message addressing property for the exception
 

Element Detail

className

public abstract java.lang.Class className
Name of the exception class

value

public abstract java.lang.String value
Value of Action message addressing property for the exception

Default:
""

JAX-WS
v2.1


Comments to: jsr224-spec-comments@sun.com
More information at: http://java.sun.com/xml/jax-ws

Copyright © 2006 by Sun Microsystems, Inc., 4150 Network Circle,
Santa Clara, California 95054, U.S.A. All Rights Reserved.