Tue, 06 Mar 2012 16:09:35 -0800
7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom
ohair@286 | 1 | /* |
ohair@286 | 2 | * Copyright (c) 1997, 2011, 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.wsdl; |
ohair@286 | 27 | |
ohair@286 | 28 | import com.sun.istack.internal.NotNull; |
ohair@286 | 29 | import com.sun.istack.internal.Nullable; |
ohair@286 | 30 | |
ohair@286 | 31 | import javax.jws.WebParam.Mode; |
ohair@286 | 32 | import javax.xml.namespace.QName; |
ohair@286 | 33 | import java.util.Map; |
ohair@286 | 34 | |
ohair@286 | 35 | /** |
ohair@286 | 36 | * Abstracts wsdl:binding/wsdl:operation. It can be used to determine the parts and their binding. |
ohair@286 | 37 | * |
ohair@286 | 38 | * @author Vivek Pandey |
ohair@286 | 39 | */ |
ohair@286 | 40 | public interface WSDLBoundOperation extends WSDLObject, WSDLExtensible { |
ohair@286 | 41 | /** |
ohair@286 | 42 | * Short-cut for {@code getOperation().getName()} |
ohair@286 | 43 | */ |
ohair@286 | 44 | @NotNull QName getName(); |
ohair@286 | 45 | |
ohair@286 | 46 | /** |
ohair@286 | 47 | * Gives soapbinding:operation@soapAction value. soapbinding:operation@soapAction is optional attribute. |
ohair@286 | 48 | * If not present an empty String is returned as per BP 1.1 R2745. |
ohair@286 | 49 | */ |
ohair@286 | 50 | @NotNull String getSOAPAction(); |
ohair@286 | 51 | |
ohair@286 | 52 | /** |
ohair@286 | 53 | * Gets the wsdl:portType/wsdl:operation model - {@link WSDLOperation}, |
ohair@286 | 54 | * associated with this binding operation. |
ohair@286 | 55 | * |
ohair@286 | 56 | * @return always same {@link WSDLOperation} |
ohair@286 | 57 | */ |
ohair@286 | 58 | @NotNull WSDLOperation getOperation(); |
ohair@286 | 59 | |
ohair@286 | 60 | /** |
ohair@286 | 61 | * Gives the owner {@link WSDLBoundPortType} |
ohair@286 | 62 | */ |
ohair@286 | 63 | @NotNull WSDLBoundPortType getBoundPortType(); |
ohair@286 | 64 | |
ohair@286 | 65 | /** |
ohair@286 | 66 | * Gets the soapbinding:binding/operation/wsaw:Anonymous. A default value of OPTIONAL is returned. |
ohair@286 | 67 | * |
ohair@286 | 68 | * @return Anonymous value of the operation |
ohair@286 | 69 | */ |
ohair@286 | 70 | ANONYMOUS getAnonymous(); |
ohair@286 | 71 | |
ohair@286 | 72 | enum ANONYMOUS { optional, required, prohibited } |
ohair@286 | 73 | |
ohair@286 | 74 | /** |
ohair@286 | 75 | * Gets {@link WSDLPart} for the given wsdl:input or wsdl:output part |
ohair@286 | 76 | * |
ohair@286 | 77 | * @return null if no part is found |
ohair@286 | 78 | */ |
ohair@286 | 79 | @Nullable WSDLPart getPart(@NotNull String partName, @NotNull Mode mode); |
ohair@286 | 80 | |
ohair@286 | 81 | /** |
ohair@286 | 82 | * Gets all inbound {@link WSDLPart} by its {@link WSDLPart#getName() name}. |
ohair@286 | 83 | */ |
ohair@286 | 84 | @NotNull Map<String,WSDLPart> getInParts(); |
ohair@286 | 85 | |
ohair@286 | 86 | /** |
ohair@286 | 87 | * Gets all outbound {@link WSDLPart} by its {@link WSDLPart#getName() name}. |
ohair@286 | 88 | */ |
ohair@286 | 89 | @NotNull Map<String,WSDLPart> getOutParts(); |
ohair@286 | 90 | |
ohair@286 | 91 | /** |
ohair@286 | 92 | * Gets all the {@link WSDLFault} bound to this operation. |
ohair@286 | 93 | */ |
ohair@286 | 94 | @NotNull Iterable<? extends WSDLBoundFault> getFaults(); |
ohair@286 | 95 | |
ohair@286 | 96 | /** |
ohair@286 | 97 | * Gets the payload QName of the request message. |
ohair@286 | 98 | * |
ohair@286 | 99 | * <p> |
ohair@286 | 100 | * It's possible for an operation to define no body part, in which case |
ohair@286 | 101 | * this method returns null. |
ohair@286 | 102 | */ |
ohair@286 | 103 | @Nullable QName getReqPayloadName(); |
ohair@286 | 104 | |
ohair@286 | 105 | /** |
ohair@286 | 106 | * Gets the payload QName of the response message. |
ohair@286 | 107 | * |
ohair@286 | 108 | * <p> |
ohair@286 | 109 | * It's possible for an operation to define no body part, in which case |
ohair@286 | 110 | * this method returns null. |
ohair@286 | 111 | */ |
ohair@286 | 112 | @Nullable QName getResPayloadName(); |
ohair@286 | 113 | |
ohair@286 | 114 | /** |
ohair@286 | 115 | * Gets the namespace of request payload. |
ohair@286 | 116 | */ |
ohair@286 | 117 | String getRequestNamespace(); |
ohair@286 | 118 | |
ohair@286 | 119 | /** |
ohair@286 | 120 | * Gets the namespace of response payload. |
ohair@286 | 121 | */ |
ohair@286 | 122 | String getResponseNamespace(); |
ohair@286 | 123 | |
ohair@286 | 124 | } |