Mercurial > jdk8-mips64-public > jaxws / annotate

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

src/share/jaxws_classes/javax/xml/ws/Action.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>Action</code> annotation allows explicit association of a
aoqi@0 36 * WS-Addressing <code>Action</code> message addressing property with
aoqi@0 37 * <code>input</code>, <code>output</code>, and
aoqi@0 38 * <code>fault</code> messages of the mapped WSDL operation.
aoqi@0 39 * <p>
aoqi@0 40 * This annotation can be specified on each method of a service endpoint interface.
aoqi@0 41 * For such a method, the mapped operation in the generated WSDL's
aoqi@0 42 * <code>wsam:Action</code> attribute on the WSDL <code>input</code>,
aoqi@0 43 * <code>output</code> and <code>fault</code> messages of the WSDL <code>operation</code>
aoqi@0 44 * is based upon which attributes of the <code>Action</code> annotation have been specified.
aoqi@0 45 * For the exact computation of <code>wsam:Action</code> values for the messages, refer
aoqi@0 46 * to the algorithm in the JAX-WS specification.
aoqi@0 47 * <p>
aoqi@0 48 * <b>Example 1</b>: Specify explicit values for <code>Action</code> message addressing property
aoqi@0 49 * for <code>input</code> and <code>output</code> messages.
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 * <b>&#64;Action(
aoqi@0 55 * input="http://example.com/inputAction",
aoqi@0 56 * output="http://example.com/outputAction")</b>
aoqi@0 57 * public int addNumbers(int number1, int number2) {
aoqi@0 58 * return number1 + number2;
aoqi@0 59 * }
aoqi@0 60 * }
aoqi@0 61 * </pre>
aoqi@0 62 *
aoqi@0 63 * The generated WSDL looks like:
aoqi@0 64 * <pre>
aoqi@0 65 * &lt;definitions targetNamespace="http://example.com/numbers" ...>
aoqi@0 66 * ...
aoqi@0 67 * &lt;portType name="AddNumbersPortType">
aoqi@0 68 * &lt;operation name="AddNumbers">
aoqi@0 69 * &lt;input message="tns:AddNumbersInput" name="foo"
aoqi@0 70 * <b>wsam:Action="http://example.com/inputAction"</b>/>
aoqi@0 71 * &lt;output message="tns:AddNumbersOutput" name="bar"
aoqi@0 72 * <b>wsam:Action="http://example.com/outputAction"</b>/>
aoqi@0 73 * &lt;/operation>
aoqi@0 74 * &lt;/portType>
aoqi@0 75 * ...
aoqi@0 76 * &lt;/definitions>
aoqi@0 77 * </pre>
aoqi@0 78 *
aoqi@0 79 * <p>
aoqi@0 80 * <b>Example 2</b>: Specify explicit value for <code>Action</code> message addressing property
aoqi@0 81 * for only the <code>input</code> message. The <code>wsam:Action</code> values for the
aoqi@0 82 * WSDL <code>output</code> message are computed using the algorithm in the JAX-WS specification.
aoqi@0 83 *
aoqi@0 84 * <pre>
aoqi@0 85 * &#64;WebService(targetNamespace="http://example.com/numbers")
aoqi@0 86 * public class AddNumbersImpl {
aoqi@0 87 * <b>&#64;Action(input="http://example.com/inputAction")</b>
aoqi@0 88 * public int addNumbers(int number1, int number2) {
aoqi@0 89 * return number1 + number2;
aoqi@0 90 * }
aoqi@0 91 * }
aoqi@0 92 * </pre>
aoqi@0 93 *
aoqi@0 94 * The generated WSDL looks like:
aoqi@0 95 * <pre>
aoqi@0 96 * &lt;definitions targetNamespace="http://example.com/numbers" ...>
aoqi@0 97 * ...
aoqi@0 98 * &lt;portType name="AddNumbersPortType">
aoqi@0 99 * &lt;operation name="AddNumbers">
aoqi@0 100 * &lt;input message="tns:AddNumbersInput" name="foo"
aoqi@0 101 * <b>wsam:Action="http://example.com/inputAction"</b> />
aoqi@0 102 * &lt;output message="tns:AddNumbersOutput" name="bar"
aoqi@0 103 * <b>wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbersResponse"</b>/>
aoqi@0 104 * &lt;/operation>
aoqi@0 105 * &lt;/portType>
aoqi@0 106 * ...
aoqi@0 107 * &lt;/definitions>
aoqi@0 108 * </pre>
aoqi@0 109 *
aoqi@0 110 * It is legitimate to specify an explicit value for <code>Action</code> message addressing property for
aoqi@0 111 * <code>output</code> message only. In this case, <code>wsam:Action</code> value for the
aoqi@0 112 * WSDL <code>input</code> message is computed using the algorithm in the JAX-WS specification.
aoqi@0 113 *
aoqi@0 114 * <p>
aoqi@0 115 * <b>Example 3</b>: See {@link FaultAction} annotation for an example of
aoqi@0 116 * how to specify an explicit value for <code>Action</code> message addressing property for the
aoqi@0 117 * <code>fault</code> message.
aoqi@0 118 *
aoqi@0 119 * @see FaultAction
aoqi@0 120 *
aoqi@0 121 * @since JAX-WS 2.1
aoqi@0 122 */
aoqi@0 123
aoqi@0 124 @Documented
aoqi@0 125 @Retention(RetentionPolicy.RUNTIME)
aoqi@0 126 @Target(ElementType.METHOD)
aoqi@0 127 public @interface Action {
aoqi@0 128 /**
aoqi@0 129 * Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>input</code>
aoqi@0 130 * message of the operation.
aoqi@0 131 */
aoqi@0 132 String input() default "";
aoqi@0 133
aoqi@0 134 /**
aoqi@0 135 * Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>output</code>
aoqi@0 136 * message of the operation.
aoqi@0 137 */
aoqi@0 138 String output() default "";
aoqi@0 139
aoqi@0 140 /**
aoqi@0 141 * Explicit value of the WS-Addressing <code>Action</code> message addressing property for the <code>fault</code>
aoqi@0 142 * message(s) of the operation. Each exception that is mapped to a fault and requires an explicit WS-Addressing
aoqi@0 143 * <code>Action</code> message addressing property, needs to be specified as a value in this property
aoqi@0 144 * using {@link FaultAction} annotation.
aoqi@0 145 */
aoqi@0 146 FaultAction[] fault() default { };
aoqi@0 147 }

Mercurial Repository: jdk8-mips64-public/jaxws

mercurial