ohair@286: /*
mkos@408:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@286:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286:  *
ohair@286:  * This code is free software; you can redistribute it and/or modify it
ohair@286:  * under the terms of the GNU General Public License version 2 only, as
ohair@286:  * published by the Free Software Foundation.  Oracle designates this
ohair@286:  * particular file as subject to the "Classpath" exception as provided
ohair@286:  * by Oracle in the LICENSE file that accompanied this code.
ohair@286:  *
ohair@286:  * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ohair@286:  * version 2 for more details (a copy is included in the LICENSE file that
ohair@286:  * accompanied this code).
ohair@286:  *
ohair@286:  * You should have received a copy of the GNU General Public License version
ohair@286:  * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286:  *
ohair@286:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286:  * or visit www.oracle.com if you need additional information or have any
ohair@286:  * questions.
ohair@286:  */
ohair@286: 
ohair@286: package com.sun.xml.internal.ws.api.model.wsdl;
ohair@286: 
ohair@286: import com.sun.istack.internal.NotNull;
ohair@286: import com.sun.istack.internal.Nullable;
ohair@286: import com.sun.xml.internal.ws.api.BindingID;
ohair@286: import com.sun.xml.internal.ws.api.message.Message;
ohair@286: import com.sun.xml.internal.ws.api.model.ParameterBinding;
ohair@286: 
ohair@286: import javax.jws.WebParam.Mode;
ohair@286: import javax.jws.soap.SOAPBinding;
ohair@286: import javax.xml.namespace.QName;
ohair@286: 
ohair@286: /**
ohair@286:  * {@link WSDLPortType} bound with a specific binding.
ohair@286:  *
ohair@286:  * @author Vivek Pandey
ohair@286:  */
ohair@286: public interface WSDLBoundPortType extends WSDLFeaturedObject, WSDLExtensible {
ohair@286:     /**
ohair@286:      * Gets the name of the wsdl:binding@name attribute value as local name and wsdl:definitions@targetNamespace
ohair@286:      * as the namespace uri.
ohair@286:      */
ohair@286:     QName getName();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link WSDLModel} that owns this port type.
ohair@286:      */
ohair@286:     @NotNull WSDLModel getOwner();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link WSDLBoundOperation} for a given operation name
ohair@286:      *
ohair@286:      * @param operationName non-null operationName
ohair@286:      * @return null if a {@link WSDLBoundOperation} is not found
ohair@286:      */
ohair@286:     public WSDLBoundOperation get(QName operationName);
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the wsdl:binding@type value, same as {@link WSDLPortType#getName()}
ohair@286:      */
ohair@286:     QName getPortTypeName();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link WSDLPortType} associated with the wsdl:binding
ohair@286:      */
ohair@286:     WSDLPortType getPortType();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link WSDLBoundOperation}s
ohair@286:      */
ohair@286:     Iterable<? extends WSDLBoundOperation> getBindingOperations();
ohair@286: 
ohair@286:     /**
ohair@286:      * Is this a document style or RPC style?
ohair@286:      *
ohair@286:      * Since we only support literal and not encoding, this means
ohair@286:      * either doc/lit or rpc/lit.
ohair@286:      */
ohair@286:     @NotNull SOAPBinding.Style getStyle();
ohair@286: 
ohair@286:     /**
ohair@286:      * Returns the binding ID.
ohair@286:      * This would typically determined by the binding extension elements in wsdl:binding.
ohair@286:      */
ohair@286:     BindingID getBindingId();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the bound operation in this port for a tag name. Here the operation would be the one whose
ohair@286:      * input part descriptor bound to soap:body is same as the tag name except for rpclit where the tag
ohair@286:      * name would be {@link WSDLBoundOperation#getName()}.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * If you have a {@link Message} and trying to figure out which operation it belongs to,
ohair@286:      * always use {@link Message#getOperation}, as that performs better.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * For example this can be used in the case when a message receipient can get the
ohair@286:      * {@link WSDLBoundOperation} from the payload tag name.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * namespaceUri and the local name both can be null to get the WSDLBoundOperation that has empty body -
ohair@286:      * there is no payload. According to BP 1.1 in a port there can be at MOST one operation with empty body.
ohair@286:      * Its an error to have namespace URI non-null but local name as null.
ohair@286:      *
ohair@286:      * @param namespaceUri namespace of the payload element.
ohair@286:      * @param localName local name of the payload
ohair@286:      * @throws NullPointerException if localName is null and namespaceUri is not.
ohair@286:      * @return
ohair@286:      *      null if no operation with the given tag name is found.
ohair@286:      */
ohair@286:     @Nullable WSDLBoundOperation getOperation(String namespaceUri, String localName);
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the {@link ParameterBinding} for a given operation, part name and the direction - IN/OUT
ohair@286:      *
ohair@286:      * @param operation wsdl:operation@name value. Must be non-null.
ohair@286:      * @param part      wsdl:part@name such as value of soap:header@part. Must be non-null.
alanb@368:      * @param mode      {@link Mode#IN} or {@link Mode#OUT}. Must be non-null.
ohair@286:      * @return null if the binding could not be resolved for the part.
ohair@286:      */
ohair@286:     ParameterBinding getBinding(QName operation, String part, Mode mode);
ohair@286: }