001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.api.model.wsdl;
038:
039: import com.sun.istack.NotNull;
040: import com.sun.istack.Nullable;
041: import com.sun.xml.ws.api.BindingID;
042: import com.sun.xml.ws.api.message.Message;
043:
044: import javax.jws.soap.SOAPBinding;
045: import javax.xml.namespace.QName;
046:
047: /**
048: * {@link WSDLPortType} bound with a specific binding.
049: *
050: * @author Vivek Pandey
051: */
052: public interface WSDLBoundPortType extends WSDLFeaturedObject,
053: WSDLExtensible {
054: /**
055: * Gets the name of the wsdl:binding@name attribute value as local name and wsdl:definitions@targetNamespace
056: * as the namespace uri.
057: */
058: QName getName();
059:
060: /**
061: * Gets the {@link WSDLModel} that owns this port type.
062: */
063: @NotNull
064: WSDLModel getOwner();
065:
066: /**
067: * Gets the {@link WSDLBoundOperation} for a given operation name
068: *
069: * @param operationName non-null operationName
070: * @return null if a {@link WSDLBoundOperation} is not found
071: */
072: public WSDLBoundOperation get(QName operationName);
073:
074: /**
075: * Gets the wsdl:binding@type value, same as {@link WSDLPortType#getName()}
076: */
077: QName getPortTypeName();
078:
079: /**
080: * Gets the {@link WSDLPortType} associated with the wsdl:binding
081: */
082: WSDLPortType getPortType();
083:
084: /**
085: * Gets the {@link WSDLBoundOperation}s
086: */
087: Iterable<? extends WSDLBoundOperation> getBindingOperations();
088:
089: /**
090: * Is this a document style or RPC style?
091: *
092: * Since we only support literal and not encoding, this means
093: * either doc/lit or rpc/lit.
094: */
095: @NotNull
096: SOAPBinding.Style getStyle();
097:
098: /**
099: * Returns the binding ID.
100: * This would typically determined by the binding extension elements in wsdl:binding.
101: */
102: BindingID getBindingId();
103:
104: /**
105: * Gets the bound operation in this port for a tag name. Here the operation would be the one whose
106: * input part descriptor bound to soap:body is same as the tag name except for rpclit where the tag
107: * name would be {@link WSDLBoundOperation#getName()}.
108: *
109: * <p>
110: * If you have a {@link Message} and trying to figure out which operation it belongs to,
111: * always use {@link Message#getOperation}, as that performs better.
112: *
113: * <p>
114: * For example this can be used in the case when a message receipient can get the
115: * {@link WSDLBoundOperation} from the payload tag name.
116: *
117: * <p>
118: * namespaceUri and the local name both can be null to get the WSDLBoundOperation that has empty body -
119: * there is no payload. According to BP 1.1 in a port there can be at MOST one operation with empty body.
120: * Its an error to have namespace URI non-null but local name as null.
121: *
122: * @param namespaceUri namespace of the payload element.
123: * @param localName local name of the payload
124: * @throws NullPointerException if localName is null and namespaceUri is not.
125: * @return
126: * null if no operation with the given tag name is found.
127: */
128: @Nullable
129: WSDLBoundOperation getOperation(String namespaceUri,
130: String localName);
131: }
|