All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.xml.ws.FaultAction Maven / Gradle / Ivy

There is a newer version: 2.3.1
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2005-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

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 className(); /** * Value of WS-Addressing Action message addressing property for the exception */ String value() default ""; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy