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

Tue, 09 Apr 2013 14:51:13 +0100

author
alanb
date
Tue, 09 Apr 2013 14:51:13 +0100
changeset 368
0989ad8c0860
parent 286
f50545b5e2f1
child 637
9c07ef4934dd
permissions
-rw-r--r--

8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com

ohair@286 1 /*
alanb@368 2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package com.sun.xml.internal.ws.api.model;
ohair@286 27
ohair@286 28 import com.sun.istack.internal.NotNull;
ohair@286 29 import com.sun.istack.internal.Nullable;
ohair@286 30 import com.sun.xml.internal.ws.api.model.soap.SOAPBinding;
ohair@286 31
ohair@286 32 import javax.xml.namespace.QName;
ohair@286 33 import java.lang.reflect.Method;
alanb@368 34 import javax.jws.WebService;
ohair@286 35
ohair@286 36 /**
ohair@286 37 * Abstracts the annotated {@link Method} of a SEI.
ohair@286 38 *
ohair@286 39 * @author Vivek Pandey
ohair@286 40 */
ohair@286 41 public interface JavaMethod {
ohair@286 42
ohair@286 43 /**
ohair@286 44 * Gets the root {@link SEIModel} that owns this model.
ohair@286 45 */
ohair@286 46 SEIModel getOwner();
ohair@286 47
ohair@286 48 /**
ohair@286 49 * On the server side, it uses this for invocation of the web service
ohair@286 50 *
ohair@286 51 * <p>
alanb@368 52 * {@literal @}{@link WebService}(endpointInterface="I")
ohair@286 53 * class A { }
ohair@286 54 *
ohair@286 55 * In this case, it retuns A's method
ohair@286 56 *
ohair@286 57 * <p>
alanb@368 58 * {@literal @}{@link WebService}(endpointInterface="I")
ohair@286 59 * class A implements I { }
ohair@286 60 * In this case, it returns A's method
ohair@286 61 *
ohair@286 62 * <p>
alanb@368 63 * {@literal @}{@link WebService}
ohair@286 64 * class A { }
ohair@286 65 * In this case, it returns A's method
ohair@286 66 *
ohair@286 67 * @return Returns the java {@link Method}
ohair@286 68 */
ohair@286 69 @NotNull Method getMethod();
ohair@286 70
ohair@286 71
ohair@286 72 /**
ohair@286 73 * This should be used if you want to access annotations on WebMethod
ohair@286 74 * Returns the SEI method if there is one.
ohair@286 75 *
ohair@286 76 * <p>
alanb@368 77 * {@literal @}{@link WebService}(endpointInterface="I")
ohair@286 78 * class A { }
ohair@286 79 * In this case, it retuns I's method
ohair@286 80 *
ohair@286 81 * <p>
alanb@368 82 * {@literal @}{@link WebService}(endpointInterface="I")
ohair@286 83 * class A implements I { }
ohair@286 84 * In this case, it returns I's method
ohair@286 85 *
ohair@286 86 * <p>
alanb@368 87 * {@literal @}{@link WebService}
ohair@286 88 * class A { }
ohair@286 89 * In this case, it returns A's method
ohair@286 90 *
ohair@286 91 * @return Returns the java {@link Method}
ohair@286 92 */
ohair@286 93 @NotNull Method getSEIMethod();
ohair@286 94
ohair@286 95 /**
ohair@286 96 * @return Returns the {@link MEP}.
ohair@286 97 */
ohair@286 98 MEP getMEP();
ohair@286 99
ohair@286 100 /**
ohair@286 101 * Binding object - a {@link SOAPBinding} isntance.
ohair@286 102 *
ohair@286 103 * @return the Binding object
ohair@286 104 */
ohair@286 105 SOAPBinding getBinding();
ohair@286 106
ohair@286 107 /**
ohair@286 108 * Gives the wsdl:operation@name value
ohair@286 109 */
ohair@286 110 @NotNull String getOperationName();
ohair@286 111
ohair@286 112
ohair@286 113 /**
ohair@286 114 * Gives the request wsdl:message@name value
ohair@286 115 */
ohair@286 116 @NotNull String getRequestMessageName();
ohair@286 117
ohair@286 118 /**
ohair@286 119 * Gives the response wsdl:messageName value
ohair@286 120 * @return null if its a oneway operation that is getMEP().isOneWay()==true.
ohair@286 121 * @see com.sun.xml.internal.ws.api.model.MEP#isOneWay()
ohair@286 122 */
ohair@286 123 @Nullable String getResponseMessageName();
ohair@286 124
ohair@286 125 /**
ohair@286 126 * Gives soap:Body's first child's name for request message.
ohair@286 127 *
ohair@286 128 * @return
ohair@286 129 * null if this operation doesn't have any request parameter bound to the body.
ohair@286 130 */
ohair@286 131 @Nullable QName getRequestPayloadName();
ohair@286 132
ohair@286 133 /**
ohair@286 134 * Gives soap:Body's first child's name for response message.
ohair@286 135 *
ohair@286 136 * @return
ohair@286 137 * null if this operation doesn't have any response parameter bound to the body.
ohair@286 138 */
ohair@286 139 @Nullable QName getResponsePayloadName();
ohair@286 140
ohair@286 141 }

mercurial