1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/jaxws_classes/com/sun/xml/internal/ws/api/model/wsdl/WSDLBoundOperation.java Tue Mar 06 16:09:35 2012 -0800
1.3 @@ -0,0 +1,124 @@
1.4 +/*
1.5 + * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.xml.internal.ws.api.model.wsdl;
1.30 +
1.31 +import com.sun.istack.internal.NotNull;
1.32 +import com.sun.istack.internal.Nullable;
1.33 +
1.34 +import javax.jws.WebParam.Mode;
1.35 +import javax.xml.namespace.QName;
1.36 +import java.util.Map;
1.37 +
1.38 +/**
1.39 + * Abstracts wsdl:binding/wsdl:operation. It can be used to determine the parts and their binding.
1.40 + *
1.41 + * @author Vivek Pandey
1.42 + */
1.43 +public interface WSDLBoundOperation extends WSDLObject, WSDLExtensible {
1.44 + /**
1.45 + * Short-cut for {@code getOperation().getName()}
1.46 + */
1.47 + @NotNull QName getName();
1.48 +
1.49 + /**
1.50 + * Gives soapbinding:operation@soapAction value. soapbinding:operation@soapAction is optional attribute.
1.51 + * If not present an empty String is returned as per BP 1.1 R2745.
1.52 + */
1.53 + @NotNull String getSOAPAction();
1.54 +
1.55 + /**
1.56 + * Gets the wsdl:portType/wsdl:operation model - {@link WSDLOperation},
1.57 + * associated with this binding operation.
1.58 + *
1.59 + * @return always same {@link WSDLOperation}
1.60 + */
1.61 + @NotNull WSDLOperation getOperation();
1.62 +
1.63 + /**
1.64 + * Gives the owner {@link WSDLBoundPortType}
1.65 + */
1.66 + @NotNull WSDLBoundPortType getBoundPortType();
1.67 +
1.68 + /**
1.69 + * Gets the soapbinding:binding/operation/wsaw:Anonymous. A default value of OPTIONAL is returned.
1.70 + *
1.71 + * @return Anonymous value of the operation
1.72 + */
1.73 + ANONYMOUS getAnonymous();
1.74 +
1.75 + enum ANONYMOUS { optional, required, prohibited }
1.76 +
1.77 + /**
1.78 + * Gets {@link WSDLPart} for the given wsdl:input or wsdl:output part
1.79 + *
1.80 + * @return null if no part is found
1.81 + */
1.82 + @Nullable WSDLPart getPart(@NotNull String partName, @NotNull Mode mode);
1.83 +
1.84 + /**
1.85 + * Gets all inbound {@link WSDLPart} by its {@link WSDLPart#getName() name}.
1.86 + */
1.87 + @NotNull Map<String,WSDLPart> getInParts();
1.88 +
1.89 + /**
1.90 + * Gets all outbound {@link WSDLPart} by its {@link WSDLPart#getName() name}.
1.91 + */
1.92 + @NotNull Map<String,WSDLPart> getOutParts();
1.93 +
1.94 + /**
1.95 + * Gets all the {@link WSDLFault} bound to this operation.
1.96 + */
1.97 + @NotNull Iterable<? extends WSDLBoundFault> getFaults();
1.98 +
1.99 + /**
1.100 + * Gets the payload QName of the request message.
1.101 + *
1.102 + * <p>
1.103 + * It's possible for an operation to define no body part, in which case
1.104 + * this method returns null.
1.105 + */
1.106 + @Nullable QName getReqPayloadName();
1.107 +
1.108 + /**
1.109 + * Gets the payload QName of the response message.
1.110 + *
1.111 + * <p>
1.112 + * It's possible for an operation to define no body part, in which case
1.113 + * this method returns null.
1.114 + */
1.115 + @Nullable QName getResPayloadName();
1.116 +
1.117 + /**
1.118 + * Gets the namespace of request payload.
1.119 + */
1.120 + String getRequestNamespace();
1.121 +
1.122 + /**
1.123 + * Gets the namespace of response payload.
1.124 + */
1.125 + String getResponseNamespace();
1.126 +
1.127 +}
