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 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
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element and Description
      Class<? extends Exception> className
      Name of the exception class

        

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      String value
      Value of WS-Addressing Action message addressing property for the exception

        

    • Element Detail

      • className

        public abstract Class<? extends Exception> className
        Name of the exception class
      • value

        public abstract String value
        Value of WS-Addressing Action message addressing property for the exception
        Default:
        ""

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

22/11/2024 01:49:19 Cette version de la page est en cache (à la date du 22/11/2024 01:49:19) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/ws/FaultAction.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut