src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/JavaMethod.java

Thu, 31 Aug 2017 15:18:52 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:18:52 +0800
changeset 637
9c07ef4934dd
parent 368
0989ad8c0860
parent 0
373ffda63c9a
permissions
-rw-r--r--

merge

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 1997, 2012, 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 com.sun.xml.internal.ws.api.model;
aoqi@0 27
aoqi@0 28 import com.sun.istack.internal.NotNull;
aoqi@0 29 import com.sun.istack.internal.Nullable;
aoqi@0 30 import com.sun.xml.internal.ws.api.model.soap.SOAPBinding;
aoqi@0 31
aoqi@0 32 import javax.xml.namespace.QName;
aoqi@0 33 import java.lang.reflect.Method;
aoqi@0 34 import javax.jws.WebService;
aoqi@0 35
aoqi@0 36 /**
aoqi@0 37 * Abstracts the annotated {@link Method} of a SEI.
aoqi@0 38 *
aoqi@0 39 * @author Vivek Pandey
aoqi@0 40 */
aoqi@0 41 public interface JavaMethod {
aoqi@0 42
aoqi@0 43 /**
aoqi@0 44 * Gets the root {@link SEIModel} that owns this model.
aoqi@0 45 */
aoqi@0 46 SEIModel getOwner();
aoqi@0 47
aoqi@0 48 /**
aoqi@0 49 * On the server side, it uses this for invocation of the web service
aoqi@0 50 *
aoqi@0 51 * <p>
aoqi@0 52 * {@literal @}{@link WebService}(endpointInterface="I")
aoqi@0 53 * class A { }
aoqi@0 54 *
aoqi@0 55 * In this case, it retuns A's method
aoqi@0 56 *
aoqi@0 57 * <p>
aoqi@0 58 * {@literal @}{@link WebService}(endpointInterface="I")
aoqi@0 59 * class A implements I { }
aoqi@0 60 * In this case, it returns A's method
aoqi@0 61 *
aoqi@0 62 * <p>
aoqi@0 63 * {@literal @}{@link WebService}
aoqi@0 64 * class A { }
aoqi@0 65 * In this case, it returns A's method
aoqi@0 66 *
aoqi@0 67 * @return Returns the java {@link Method}
aoqi@0 68 */
aoqi@0 69 @NotNull Method getMethod();
aoqi@0 70
aoqi@0 71
aoqi@0 72 /**
aoqi@0 73 * This should be used if you want to access annotations on WebMethod
aoqi@0 74 * Returns the SEI method if there is one.
aoqi@0 75 *
aoqi@0 76 * <p>
aoqi@0 77 * {@literal @}{@link WebService}(endpointInterface="I")
aoqi@0 78 * class A { }
aoqi@0 79 * In this case, it retuns I's method
aoqi@0 80 *
aoqi@0 81 * <p>
aoqi@0 82 * {@literal @}{@link WebService}(endpointInterface="I")
aoqi@0 83 * class A implements I { }
aoqi@0 84 * In this case, it returns I's method
aoqi@0 85 *
aoqi@0 86 * <p>
aoqi@0 87 * {@literal @}{@link WebService}
aoqi@0 88 * class A { }
aoqi@0 89 * In this case, it returns A's method
aoqi@0 90 *
aoqi@0 91 * @return Returns the java {@link Method}
aoqi@0 92 */
aoqi@0 93 @NotNull Method getSEIMethod();
aoqi@0 94
aoqi@0 95 /**
aoqi@0 96 * @return Returns the {@link MEP}.
aoqi@0 97 */
aoqi@0 98 MEP getMEP();
aoqi@0 99
aoqi@0 100 /**
aoqi@0 101 * Binding object - a {@link SOAPBinding} isntance.
aoqi@0 102 *
aoqi@0 103 * @return the Binding object
aoqi@0 104 */
aoqi@0 105 SOAPBinding getBinding();
aoqi@0 106
aoqi@0 107 /**
aoqi@0 108 * Gives the wsdl:operation@name value
aoqi@0 109 */
aoqi@0 110 @NotNull String getOperationName();
aoqi@0 111
aoqi@0 112
aoqi@0 113 /**
aoqi@0 114 * Gives the request wsdl:message@name value
aoqi@0 115 */
aoqi@0 116 @NotNull String getRequestMessageName();
aoqi@0 117
aoqi@0 118 /**
aoqi@0 119 * Gives the response wsdl:messageName value
aoqi@0 120 * @return null if its a oneway operation that is getMEP().isOneWay()==true.
aoqi@0 121 * @see com.sun.xml.internal.ws.api.model.MEP#isOneWay()
aoqi@0 122 */
aoqi@0 123 @Nullable String getResponseMessageName();
aoqi@0 124
aoqi@0 125 /**
aoqi@0 126 * Gives soap:Body's first child's name for request message.
aoqi@0 127 *
aoqi@0 128 * @return
aoqi@0 129 * null if this operation doesn't have any request parameter bound to the body.
aoqi@0 130 */
aoqi@0 131 @Nullable QName getRequestPayloadName();
aoqi@0 132
aoqi@0 133 /**
aoqi@0 134 * Gives soap:Body's first child's name for response message.
aoqi@0 135 *
aoqi@0 136 * @return
aoqi@0 137 * null if this operation doesn't have any response parameter bound to the body.
aoqi@0 138 */
aoqi@0 139 @Nullable QName getResponsePayloadName();
aoqi@0 140
aoqi@0 141 }

mercurial