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

javax.xml.ws.Action 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 Action annotation allows explicit association of a 
 * WS-Addressing Action message addressing property with 
 * input, output, and 
 * fault messages of the mapped WSDL operation. 
 * 

* This annotation can be specified on each method of a service endpoint interface. * For such a method, the mapped operation in the generated WSDL's * wsam:Action attribute on the WSDL input, * output and fault messages of the WSDL operation * is based upon which attributes of the Action annotation have been specified. * For the exact computation of wsam:Action values for the messages, refer * to the algorithm in the JAX-WS specification. *

* Example 1: Specify explicit values for Action message addressing property * for input and output messages. * *

 * @WebService(targetNamespace="http://example.com/numbers")
 * public class AddNumbersImpl {
 *     @Action(
 *         input="http://example.com/inputAction",
 *         output="http://example.com/outputAction")
 *     public int addNumbers(int number1, int number2) {
 *         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="foo"
 *           wsam:Action="http://example.com/inputAction"/>
 *         <output message="tns:AddNumbersOutput" name="bar"
 *           wsam:Action="http://example.com/outputAction"/>
 *       </operation>
 *     </portType>
 *     ...
 *   </definitions>
 * 
* *

* Example 2: Specify explicit value for Action message addressing property * for only the input message. The wsam:Action values for the * WSDL output message are computed using the algorithm in the JAX-WS specification. * *

 * @WebService(targetNamespace="http://example.com/numbers")
 * public class AddNumbersImpl {
 *     @Action(input="http://example.com/inputAction")
 *     public int addNumbers(int number1, int number2) {
 *         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="foo"
 *           wsam:Action="http://example.com/inputAction" />
 *         <output message="tns:AddNumbersOutput" name="bar"
 *           wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbersResponse"/>
 *       </operation>
 *     </portType>
 *     ...
 *   </definitions>
 * 
* * It is legitimate to specify an explicit value for Action message addressing property for * output message only. In this case, wsam:Action value for the * WSDL input message is computed using the algorithm in the JAX-WS specification. * *

* Example 3: See {@link FaultAction} annotation for an example of * how to specify an explicit value for Action message addressing property for the * fault message. * * @see FaultAction * * @since JAX-WS 2.1 */ @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Action { /** * Explicit value of the WS-Addressing Action message addressing property for the input * message of the operation. */ String input() default ""; /** * Explicit value of the WS-Addressing Action message addressing property for the output * message of the operation. */ String output() default ""; /** * Explicit value of the WS-Addressing Action message addressing property for the fault * message(s) of the operation. Each exception that is mapped to a fault and requires an explicit WS-Addressing * Action message addressing property, needs to be specified as a value in this property * using {@link FaultAction} annotation. */ FaultAction[] fault() default { }; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy