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

Fri, 04 Oct 2013 16:21:34 +0100

author
mkos
date
Fri, 04 Oct 2013 16:21:34 +0100
changeset 408
b0610cd08440
parent 368
0989ad8c0860
child 637
9c07ef4934dd
permissions
-rw-r--r--

8025054: Update JAX-WS RI integration to 2.2.9-b130926.1035
Reviewed-by: chegar

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

mercurial