Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLBoundPortType.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLBoundPortType.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 408
- b0610cd08440
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2013, 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.wsdl; |
| 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.BindingID; |
| aoqi@0 | 31 | import com.sun.xml.internal.ws.api.message.Message; |
| aoqi@0 | 32 | import com.sun.xml.internal.ws.api.model.ParameterBinding; |
| aoqi@0 | 33 | |
| aoqi@0 | 34 | import javax.jws.WebParam.Mode; |
| aoqi@0 | 35 | import javax.jws.soap.SOAPBinding; |
| aoqi@0 | 36 | import javax.xml.namespace.QName; |
| aoqi@0 | 37 | |
| aoqi@0 | 38 | /** |
| aoqi@0 | 39 | * {@link WSDLPortType} bound with a specific binding. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * @author Vivek Pandey |
| aoqi@0 | 42 | */ |
| aoqi@0 | 43 | public interface WSDLBoundPortType extends WSDLFeaturedObject, WSDLExtensible { |
| aoqi@0 | 44 | /** |
| aoqi@0 | 45 | * Gets the name of the wsdl:binding@name attribute value as local name and wsdl:definitions@targetNamespace |
| aoqi@0 | 46 | * as the namespace uri. |
| aoqi@0 | 47 | */ |
| aoqi@0 | 48 | QName getName(); |
| aoqi@0 | 49 | |
| aoqi@0 | 50 | /** |
| aoqi@0 | 51 | * Gets the {@link WSDLModel} that owns this port type. |
| aoqi@0 | 52 | */ |
| aoqi@0 | 53 | @NotNull WSDLModel getOwner(); |
| aoqi@0 | 54 | |
| aoqi@0 | 55 | /** |
| aoqi@0 | 56 | * Gets the {@link WSDLBoundOperation} for a given operation name |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * @param operationName non-null operationName |
| aoqi@0 | 59 | * @return null if a {@link WSDLBoundOperation} is not found |
| aoqi@0 | 60 | */ |
| aoqi@0 | 61 | public WSDLBoundOperation get(QName operationName); |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | /** |
| aoqi@0 | 64 | * Gets the wsdl:binding@type value, same as {@link WSDLPortType#getName()} |
| aoqi@0 | 65 | */ |
| aoqi@0 | 66 | QName getPortTypeName(); |
| aoqi@0 | 67 | |
| aoqi@0 | 68 | /** |
| aoqi@0 | 69 | * Gets the {@link WSDLPortType} associated with the wsdl:binding |
| aoqi@0 | 70 | */ |
| aoqi@0 | 71 | WSDLPortType getPortType(); |
| aoqi@0 | 72 | |
| aoqi@0 | 73 | /** |
| aoqi@0 | 74 | * Gets the {@link WSDLBoundOperation}s |
| aoqi@0 | 75 | */ |
| aoqi@0 | 76 | Iterable<? extends WSDLBoundOperation> getBindingOperations(); |
| aoqi@0 | 77 | |
| aoqi@0 | 78 | /** |
| aoqi@0 | 79 | * Is this a document style or RPC style? |
| aoqi@0 | 80 | * |
| aoqi@0 | 81 | * Since we only support literal and not encoding, this means |
| aoqi@0 | 82 | * either doc/lit or rpc/lit. |
| aoqi@0 | 83 | */ |
| aoqi@0 | 84 | @NotNull SOAPBinding.Style getStyle(); |
| aoqi@0 | 85 | |
| aoqi@0 | 86 | /** |
| aoqi@0 | 87 | * Returns the binding ID. |
| aoqi@0 | 88 | * This would typically determined by the binding extension elements in wsdl:binding. |
| aoqi@0 | 89 | */ |
| aoqi@0 | 90 | BindingID getBindingId(); |
| aoqi@0 | 91 | |
| aoqi@0 | 92 | /** |
| aoqi@0 | 93 | * Gets the bound operation in this port for a tag name. Here the operation would be the one whose |
| aoqi@0 | 94 | * input part descriptor bound to soap:body is same as the tag name except for rpclit where the tag |
| aoqi@0 | 95 | * name would be {@link WSDLBoundOperation#getName()}. |
| aoqi@0 | 96 | * |
| aoqi@0 | 97 | * <p> |
| aoqi@0 | 98 | * If you have a {@link Message} and trying to figure out which operation it belongs to, |
| aoqi@0 | 99 | * always use {@link Message#getOperation}, as that performs better. |
| aoqi@0 | 100 | * |
| aoqi@0 | 101 | * <p> |
| aoqi@0 | 102 | * For example this can be used in the case when a message receipient can get the |
| aoqi@0 | 103 | * {@link WSDLBoundOperation} from the payload tag name. |
| aoqi@0 | 104 | * |
| aoqi@0 | 105 | * <p> |
| aoqi@0 | 106 | * namespaceUri and the local name both can be null to get the WSDLBoundOperation that has empty body - |
| aoqi@0 | 107 | * there is no payload. According to BP 1.1 in a port there can be at MOST one operation with empty body. |
| aoqi@0 | 108 | * Its an error to have namespace URI non-null but local name as null. |
| aoqi@0 | 109 | * |
| aoqi@0 | 110 | * @param namespaceUri namespace of the payload element. |
| aoqi@0 | 111 | * @param localName local name of the payload |
| aoqi@0 | 112 | * @throws NullPointerException if localName is null and namespaceUri is not. |
| aoqi@0 | 113 | * @return |
| aoqi@0 | 114 | * null if no operation with the given tag name is found. |
| aoqi@0 | 115 | */ |
| aoqi@0 | 116 | @Nullable WSDLBoundOperation getOperation(String namespaceUri, String localName); |
| aoqi@0 | 117 | |
| aoqi@0 | 118 | /** |
| aoqi@0 | 119 | * Gets the {@link ParameterBinding} for a given operation, part name and the direction - IN/OUT |
| aoqi@0 | 120 | * |
| aoqi@0 | 121 | * @param operation wsdl:operation@name value. Must be non-null. |
| aoqi@0 | 122 | * @param part wsdl:part@name such as value of soap:header@part. Must be non-null. |
| aoqi@0 | 123 | * @param mode {@link Mode#IN} or {@link Mode#OUT}. Must be non-null. |
| aoqi@0 | 124 | * @return null if the binding could not be resolved for the part. |
| aoqi@0 | 125 | */ |
| aoqi@0 | 126 | ParameterBinding getBinding(QName operation, String part, Mode mode); |
| aoqi@0 | 127 | } |
