Mercurial > jdk8-mips64-public > jaxws / annotate

src/share/jaxws_classes/javax/xml/ws/FaultAction.java@f453f4eaf8b4 (annotated)

src/share/jaxws_classes/javax/xml/ws/FaultAction.java

Tue, 07 Nov 2017 18:54:04 -0800

author
asaha
date
Tue, 07 Nov 2017 18:54:04 -0800
changeset 1528
f453f4eaf8b4
parent 0
373ffda63c9a
permissions
-rw-r--r--

Added tag jdk8u162-b06 for changeset 6095742f8034

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25
aoqi@0 26 package javax.xml.ws;
aoqi@0 27
aoqi@0 28 import java.lang.annotation.Documented;
aoqi@0 29 import java.lang.annotation.ElementType;
aoqi@0 30 import java.lang.annotation.Retention;
aoqi@0 31 import java.lang.annotation.RetentionPolicy;
aoqi@0 32 import java.lang.annotation.Target;
aoqi@0 33
aoqi@0 34 /**
aoqi@0 35 * The <code>FaultAction</code> annotation is used inside an {@link Action}
aoqi@0 36 * annotation to allow an explicit association of a WS-Addressing
aoqi@0 37 * <code>Action</code> message addressing property with the <code>fault</code>
aoqi@0 38 * messages of the WSDL operation mapped from the exception class.
aoqi@0 39 * <p>
aoqi@0 40 * The <code>wsam:Action</code> attribute value in the <code>fault</code>
aoqi@0 41 * message in the generated WSDL operation mapped for <code>className</code>
aoqi@0 42 * class is equal to the corresponding value in the <code>FaultAction</code>.
aoqi@0 43 * For the exact computation of <code>wsam:Action</code> values for the
aoqi@0 44 * fault messages, refer to the algorithm in the JAX-WS specification.
aoqi@0 45 *
aoqi@0 46 * <p>
aoqi@0 47 * <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing
aoqi@0 48 * property for the <code>input</code>, <code>output</code> and <code>fault</code> message
aoqi@0 49 * if the Java method throws only one service specific exception.
aoqi@0 50 *
aoqi@0 51 * <pre>
aoqi@0 52 * &#64;WebService(targetNamespace="http://example.com/numbers")
aoqi@0 53 * public class AddNumbersImpl {
aoqi@0 54 * &#64;Action(
aoqi@0 55 * fault = {
aoqi@0 56 * <b>&#64;FaultAction(className=AddNumbersException.class, value="http://example.com/faultAction")</b>
aoqi@0 57 * })
aoqi@0 58 * public int addNumbers(int number1, int number2)
aoqi@0 59 * throws AddNumbersException {
aoqi@0 60 * return number1 + number2;
aoqi@0 61 * }
aoqi@0 62 * }
aoqi@0 63 * </pre>
aoqi@0 64 *
aoqi@0 65 * The generated WSDL looks like:
aoqi@0 66 *
aoqi@0 67 * <pre>
aoqi@0 68 * &lt;definitions targetNamespace="http://example.com/numbers" ...>
aoqi@0 69 * ...
aoqi@0 70 * &lt;portType name="AddNumbersPortType">
aoqi@0 71 * &lt;operation name="AddNumbers">
aoqi@0 72 * ...
aoqi@0 73 * &lt;fault message="tns:AddNumbersException" name="AddNumbersException"
aoqi@0 74 * <b>wsam:Action="http://example.com/faultAction"</b>/>
aoqi@0 75 * &lt;/operation>
aoqi@0 76 * &lt;/portType>
aoqi@0 77 * ...
aoqi@0 78 * &lt;/definitions>
aoqi@0 79 * </pre>
aoqi@0 80 *
aoqi@0 81 * <p>
aoqi@0 82 * Example 2: Here is an example that shows if the explicit value for <code>Action</code>
aoqi@0 83 * message addressing property for the service specific exception is not present.
aoqi@0 84 *
aoqi@0 85 * <pre>
aoqi@0 86 * &#64;WebService(targetNamespace="http://example.com/numbers")
aoqi@0 87 * public class AddNumbersImpl {
aoqi@0 88 * public int addNumbers(int number1, int number2)
aoqi@0 89 * throws AddNumbersException {
aoqi@0 90 * return number1 + number2;
aoqi@0 91 * }
aoqi@0 92 * }
aoqi@0 93 * </pre>
aoqi@0 94 *
aoqi@0 95 * The generated WSDL looks like:
aoqi@0 96 *
aoqi@0 97 * <pre>
aoqi@0 98 * &lt;definitions targetNamespace="http://example.com/numbers" ...>
aoqi@0 99 * ...
aoqi@0 100 * &lt;portType name="AddNumbersPortType">
aoqi@0 101 * &lt;operation name="AddNumbers">
aoqi@0 102 * ...
aoqi@0 103 * &lt;fault message="tns:addNumbersFault" name="InvalidNumbers"
aoqi@0 104 * <b>wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbers/Fault/AddNumbersException"</b>/>
aoqi@0 105 * &lt;/operation>
aoqi@0 106 * &lt;/portType>
aoqi@0 107 * ...
aoqi@0 108 * &lt;/definitions>
aoqi@0 109 * </pre>
aoqi@0 110 *
aoqi@0 111 * <p>
aoqi@0 112 * Example 3: Here is an example that shows how to specify explicit values for <code>Action</code>
aoqi@0 113 * message addressing property if the Java method throws more than one service specific exception.
aoqi@0 114 *
aoqi@0 115 * <pre>
aoqi@0 116 * &#64;WebService(targetNamespace="http://example.com/numbers")
aoqi@0 117 * public class AddNumbersImpl {
aoqi@0 118 * &#64;Action(
aoqi@0 119 * fault = {
aoqi@0 120 * <b>&#64;FaultAction(className=AddNumbersException.class, value="http://example.com/addFaultAction"),
aoqi@0 121 * &#64;FaultAction(className=TooBigNumbersException.class, value="http://example.com/toobigFaultAction")</b>
aoqi@0 122 * })
aoqi@0 123 * public int addNumbers(int number1, int number2)
aoqi@0 124 * throws AddNumbersException, TooBigNumbersException {
aoqi@0 125 * return number1 + number2;
aoqi@0 126 * }
aoqi@0 127 * }
aoqi@0 128 * </pre>
aoqi@0 129 *
aoqi@0 130 * The generated WSDL looks like:
aoqi@0 131 *
aoqi@0 132 * <pre>
aoqi@0 133 * &lt;definitions targetNamespace="http://example.com/numbers" ...>
aoqi@0 134 * ...
aoqi@0 135 * &lt;portType name="AddNumbersPortType">
aoqi@0 136 * &lt;operation name="AddNumbers">
aoqi@0 137 * ...
aoqi@0 138 * &lt;fault message="tns:addNumbersFault" name="AddNumbersException"
aoqi@0 139 * <b>wsam:Action="http://example.com/addFaultAction"</b>/>
aoqi@0 140 * &lt;fault message="tns:tooBigNumbersFault" name="TooBigNumbersException"
aoqi@0 141 * <b>wsam:Action="http://example.com/toobigFaultAction"</b>/>
aoqi@0 142 * &lt;/operation>
aoqi@0 143 * &lt;/portType>
aoqi@0 144 * ...
aoqi@0 145 * &lt;/definitions>
aoqi@0 146 * </pre>
aoqi@0 147 *
aoqi@0 148 * @since JAX-WS 2.1
aoqi@0 149 */
aoqi@0 150
aoqi@0 151 @Documented
aoqi@0 152 @Retention(RetentionPolicy.RUNTIME)
aoqi@0 153 @Target(ElementType.METHOD)
aoqi@0 154 public @interface FaultAction {
aoqi@0 155 /**
aoqi@0 156 * Name of the exception class
aoqi@0 157 */
aoqi@0 158 Class<? extends Exception> className();
aoqi@0 159
aoqi@0 160 /**
aoqi@0 161 * Value of WS-Addressing <code>Action</code> message addressing property for the exception
aoqi@0 162 */
aoqi@0 163 String value() default "";
aoqi@0 164 }

Mercurial Repository: jdk8-mips64-public/jaxws

mercurial