325N/A/*
325N/A * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
325N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
325N/A *
325N/A * This code is free software; you can redistribute it and/or modify it
325N/A * under the terms of the GNU General Public License version 2 only, as
325N/A * published by the Free Software Foundation. Oracle designates this
325N/A * particular file as subject to the "Classpath" exception as provided
325N/A * by Oracle in the LICENSE file that accompanied this code.
325N/A *
325N/A * This code is distributed in the hope that it will be useful, but WITHOUT
325N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
325N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
325N/A * version 2 for more details (a copy is included in the LICENSE file that
325N/A * accompanied this code).
325N/A *
325N/A * You should have received a copy of the GNU General Public License version
325N/A * 2 along with this work; if not, write to the Free Software Foundation,
325N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
325N/A *
325N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
325N/A * or visit www.oracle.com if you need additional information or have any
325N/A * questions.
325N/A */
325N/A
325N/Apackage javax.jws;
325N/A
325N/Aimport java.lang.annotation.Retention;
325N/Aimport java.lang.annotation.RetentionPolicy;
325N/Aimport java.lang.annotation.Target;
325N/Aimport java.lang.annotation.ElementType;
325N/A
325N/A/**
325N/A * Customizes the mapping of an individual parameter to a Web Service message part and XML element.
325N/A */
325N/A@Retention(value = RetentionPolicy.RUNTIME)
325N/A@Target(value = {ElementType.PARAMETER})
325N/Apublic @interface WebParam {
325N/A
325N/A /**
325N/A * The direction in which the parameter flows
325N/A */
325N/A public enum Mode {
325N/A IN,
325N/A OUT,
325N/A INOUT
325N/A };
325N/A
325N/A /**
325N/A * Name of the parameter.
325N/A * <p>
325N/A * If the operation is rpc style and @WebParam.partName has not been specified, this is name of the wsdl:part
325N/A * representing the parameter.
325N/A * <br>
325N/A * If the operation is document style or the parameter maps to a header, this is the local name of the XML element
325N/A * representing the parameter.
325N/A * <p>
325N/A * A name MUST be specified if the operation is document style, the parameter style is BARE, and the mode is OUT
325N/A * or INOUT.
325N/A *
325N/A * @specdefault
325N/A * If the operation is document style and the parameter style is BARE, {@code @WebMethod.operationName}.<br>
325N/A * Otherwise, argN, where N represents the index of the parameter in the method signature (starting at arg0).
325N/A */
325N/A String name() default "";
325N/A
325N/A /**
325N/A * The name of the wsdl:part representing this parameter.
325N/A * <p>
325N/A * This is only used if the operation is rpc style or if the operation is document style and the parameter style
325N/A * is BARE.
325N/A *
325N/A * @specdefault {@code @WebParam.name}
325N/A *
325N/A * @since 2.0
325N/A */
325N/A String partName() default "";
325N/A
325N/A /**
325N/A * The XML namespace for the parameter.
325N/A * <p>
325N/A * Only used if the operation is document style or the paramater maps to a header.
325N/A * If the target namespace is set to "", this represents the empty namespace.
325N/A *
325N/A * @specdefault
325N/A * If the operation is document style, the parameter style is WRAPPED, and the parameter does not map to a
325N/A * header, the empty namespace.<br>
325N/A * Otherwise, the targetNamespace for the Web Service.
325N/A */
325N/A String targetNamespace() default "";
325N/A
325N/A /**
325N/A * The direction in which the parameter is flowing (One of IN, OUT, or INOUT).
325N/A * <p>
325N/A * The OUT and INOUT modes may only be specified for parameter types that conform to the definition of Holder types
325N/A * (JAX-WS 2.0 [5], section 2.3.3). Parameters that are Holder Types MUST be OUT or INOUT.
325N/A *
325N/A * @specdefault
325N/A * INOUT if a Holder type.<br>
325N/A * IN if not a Holder type.
325N/A */
325N/A Mode mode() default Mode.IN;
325N/A
325N/A /**
325N/A * If true, the parameter is pulled from a message header rather then the message body.
325N/A */
325N/A boolean header() default false;
325N/A};