1 /*
   2  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws;
  27 
  28 import java.lang.annotation.Documented;
  29 import java.lang.annotation.Target;
  30 import java.lang.annotation.Retention;
  31 import java.lang.annotation.ElementType;
  32 import java.lang.annotation.RetentionPolicy;
  33 /**
  34  * Used to annotate methods in the Service Endpoint Interface with the response
  35  * wrapper bean to be used at runtime. The default value of the {@code localName} is
  36  * the {@code operationName} as defined in {@code WebMethod} annotation appended with
  37  * {@code Response} and the {@code targetNamespace} is the target namespace of the SEI.
  38  * <p> When starting from Java this annotation is used resolve
  39  * overloading conflicts in document literal mode. Only the {@code className}
  40  * is required in this case.
  41  *
  42  *  @since 1.6, JAX-WS 2.0
  43 **/
  44 
  45 @Target(ElementType.METHOD)
  46 @Retention(RetentionPolicy.RUNTIME)
  47 @Documented
  48 public @interface ResponseWrapper {
  49 
  50     /**
  51      * Element's local name.
  52      * @return local name
  53      */
  54     public String localName() default "";
  55 
  56     /**
  57      * Element's namespace name.
  58      * @return target namespace name
  59      */
  60     public String targetNamespace() default "";
  61 
  62     /**
  63      * Response wrapper bean name.
  64      * @return bean name
  65      */
  66     public String className() default "";
  67 
  68     /**
  69      * wsdl:part name for the wrapper part
  70      *
  71      * @return wsdl:part name
  72      * @since 1.7, JAX-WS 2.2
  73      */
  74     public String partName() default "";
  75 
  76 }