/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.api.model.wsdl;
import com.sun.istack.NotNull;
import com.sun.istack.Nullable;
import com.sun.xml.ws.api.BindingID;
import com.sun.xml.ws.api.message.Message;
import com.sun.xml.ws.api.model.ParameterBinding;
import javax.jws.WebParam.Mode;
import javax.jws.soap.SOAPBinding;
import javax.xml.namespace.QName;
/**
* {@link WSDLPortType} bound with a specific binding.
*
* @author Vivek Pandey
*/
public interface WSDLBoundPortType extends WSDLFeaturedObject, WSDLExtensible {
/**
* Gets the name of the wsdl:binding@name attribute value as local name and wsdl:definitions@targetNamespace
* as the namespace uri.
*/
QName getName();
/**
* Gets the {@link WSDLModel} that owns this port type.
*/
@NotNull WSDLModel getOwner();
/**
* Gets the {@link WSDLBoundOperation} for a given operation name
*
* @param operationName non-null operationName
* @return null if a {@link WSDLBoundOperation} is not found
*/
public WSDLBoundOperation get(QName operationName);
/**
* Gets the wsdl:binding@type value, same as {@link WSDLPortType#getName()}
*/
QName getPortTypeName();
/**
* Gets the {@link WSDLPortType} associated with the wsdl:binding
*/
WSDLPortType getPortType();
/**
* Gets the {@link WSDLBoundOperation}s
*/
Iterable<? extends WSDLBoundOperation> getBindingOperations();
/**
* Is this a document style or RPC style?
*
* Since we only support literal and not encoding, this means
* either doc/lit or rpc/lit.
*/
@NotNull SOAPBinding.Style getStyle();
/**
* Returns the binding ID.
* This would typically determined by the binding extension elements in wsdl:binding.
*/
BindingID getBindingId();
/**
* Gets the bound operation in this port for a tag name. Here the operation would be the one whose
* input part descriptor bound to soap:body is same as the tag name except for rpclit where the tag
* name would be {@link WSDLBoundOperation#getName()}.
*
* <p>
* If you have a {@link Message} and trying to figure out which operation it belongs to,
* always use {@link Message#getOperation}, as that performs better.
*
* <p>
* For example this can be used in the case when a message receipient can get the
* {@link WSDLBoundOperation} from the payload tag name.
*
* <p>
* namespaceUri and the local name both can be null to get the WSDLBoundOperation that has empty body -
* there is no payload. According to BP 1.1 in a port there can be at MOST one operation with empty body.
* Its an error to have namespace URI non-null but local name as null.
*
* @param namespaceUri namespace of the payload element.
* @param localName local name of the payload
* @throws NullPointerException if localName is null and namespaceUri is not.
* @return
* null if no operation with the given tag name is found.
*/
@Nullable WSDLBoundOperation getOperation(String namespaceUri, String localName);
/**
* Gets the {@link ParameterBinding} for a given operation, part name and the direction - IN/OUT
*
* @param operation wsdl:operation@name value. Must be non-null.
* @param part wsdl:part@name such as value of soap:header@part. Must be non-null.
* @param mode {@link Mode#IN} or {@link Mode#OUT}. Must be non-null.
* @return null if the binding could not be resolved for the part.
*/
ParameterBinding getBinding(QName operation, String part, Mode mode);
}