ohair@286: /*
ohair@286:  * Copyright (c) 1997, 2011, 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: 
ohair@286: import javax.jws.WebParam.Mode;
ohair@286: import javax.xml.namespace.QName;
ohair@286: import java.util.Map;
ohair@286: 
ohair@286: /**
ohair@286:  * Abstracts wsdl:binding/wsdl:operation. It can be used to determine the parts and their binding.
ohair@286:  *
ohair@286:  * @author Vivek Pandey
ohair@286:  */
ohair@286: public interface WSDLBoundOperation extends WSDLObject, WSDLExtensible {
ohair@286:     /**
ohair@286:      * Short-cut for {@code getOperation().getName()}
ohair@286:      */
ohair@286:     @NotNull QName getName();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gives soapbinding:operation@soapAction value. soapbinding:operation@soapAction is optional attribute.
ohair@286:      * If not present an empty String is returned as per BP 1.1 R2745.
ohair@286:      */
ohair@286:     @NotNull String getSOAPAction();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the wsdl:portType/wsdl:operation model - {@link WSDLOperation},
ohair@286:      * associated with this binding operation.
ohair@286:      *
ohair@286:      * @return always same {@link WSDLOperation}
ohair@286:      */
ohair@286:     @NotNull WSDLOperation getOperation();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gives the owner {@link WSDLBoundPortType}
ohair@286:      */
ohair@286:     @NotNull WSDLBoundPortType getBoundPortType();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the soapbinding:binding/operation/wsaw:Anonymous. A default value of OPTIONAL is returned.
ohair@286:      *
ohair@286:      * @return Anonymous value of the operation
ohair@286:      */
ohair@286:     ANONYMOUS getAnonymous();
ohair@286: 
ohair@286:     enum ANONYMOUS { optional, required, prohibited }
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets {@link WSDLPart} for the given wsdl:input or wsdl:output part
ohair@286:      *
ohair@286:      * @return null if no part is found
ohair@286:      */
ohair@286:     @Nullable WSDLPart getPart(@NotNull String partName, @NotNull Mode mode);
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets all inbound {@link WSDLPart} by its {@link WSDLPart#getName() name}.
ohair@286:      */
ohair@286:     @NotNull Map<String,WSDLPart> getInParts();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets all outbound {@link WSDLPart} by its {@link WSDLPart#getName() name}.
ohair@286:      */
ohair@286:     @NotNull Map<String,WSDLPart> getOutParts();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets all the {@link WSDLFault} bound to this operation.
ohair@286:      */
ohair@286:     @NotNull Iterable<? extends WSDLBoundFault> getFaults();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the payload QName of the request message.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * It's possible for an operation to define no body part, in which case
ohair@286:      * this method returns null.
ohair@286:      */
ohair@286:     @Nullable QName getReqPayloadName();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the payload QName of the response message.
ohair@286:      *
ohair@286:      * <p>
ohair@286:      * It's possible for an operation to define no body part, in which case
ohair@286:      * this method returns null.
ohair@286:      */
ohair@286:     @Nullable QName getResPayloadName();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the namespace of request payload.
ohair@286:      */
ohair@286:     String getRequestNamespace();
ohair@286: 
ohair@286:     /**
ohair@286:      * Gets the namespace of response payload.
ohair@286:      */
ohair@286:     String getResponseNamespace();
ohair@286: 
ohair@286: }