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.xml.ws.api.wsdl.parser.WSDLParserExtension;
041: import com.sun.xml.ws.api.wsdl.parser.XMLEntityResolver;
042: import com.sun.xml.ws.wsdl.parser.RuntimeWSDLParser;
043: import org.xml.sax.SAXException;
044:
045: import javax.xml.namespace.QName;
046: import javax.xml.stream.XMLStreamException;
047: import java.io.IOException;
048: import java.util.Map;
049:
050: /**
051: * Provides abstraction of wsdl:definitions.
052: *
053: * @author Vivek Pandey
054: */
055: public interface WSDLModel extends WSDLExtensible {
056: /**
057: * Gets {@link WSDLPortType} that models <code>wsdl:portType</code>
058: *
059: * @param name non-null quaified name of wsdl:message, where the localName is the value of <code>wsdl:portType@name</code> and
060: * the namespaceURI is the value of wsdl:definitions@targetNamespace
061: * @return A {@link com.sun.xml.ws.api.model.wsdl.WSDLPortType} or null if no wsdl:portType found.
062: */
063: WSDLPortType getPortType(@NotNull
064: QName name);
065:
066: /**
067: * Gets {@link WSDLBoundPortType} that models <code>wsdl:binding</code>
068: *
069: * @param name non-null quaified name of wsdl:binding, where the localName is the value of <code>wsdl:binding@name</code> and
070: * the namespaceURI is the value of wsdl:definitions@targetNamespace
071: * @return A {@link WSDLBoundPortType} or null if no wsdl:binding found
072: */
073: WSDLBoundPortType getBinding(@NotNull
074: QName name);
075:
076: /**
077: * Give a {@link WSDLBoundPortType} for the given wsdl:service and wsdl:port names.
078: *
079: * @param serviceName service QName
080: * @param portName port QName
081: * @return A {@link WSDLBoundPortType}. null if the Binding for the given wsd:service and wsdl:port name are not
082: * found.
083: */
084: WSDLBoundPortType getBinding(@NotNull
085: QName serviceName, @NotNull
086: QName portName);
087:
088: /**
089: * Gets {@link WSDLService} that models <code>wsdl:service</code>
090: *
091: * @param name non-null quaified name of wsdl:service, where the localName is the value of <code>wsdl:service@name</code> and
092: * the namespaceURI is the value of wsdl:definitions@targetNamespace
093: * @return A {@link WSDLService} or null if no wsdl:service found
094: */
095: WSDLService getService(@NotNull
096: QName name);
097:
098: /**
099: * Gives a {@link Map} of wsdl:portType {@link QName} and {@link WSDLPortType}
100: *
101: * @return an empty Map if the wsdl document has no wsdl:portType
102: */
103: @NotNull
104: Map<QName, ? extends WSDLPortType> getPortTypes();
105:
106: /**
107: * Gives a {@link Map} of wsdl:binding {@link QName} and {@link WSDLBoundPortType}
108: *
109: * @return an empty Map if the wsdl document has no wsdl:binding
110: */
111: @NotNull
112: Map<QName, WSDLBoundPortType> getBindings();
113:
114: /**
115: * Gives a {@link Map} of wsdl:service qualified name and {@link com.sun.xml.ws.api.model.wsdl.WSDLService}
116: *
117: * @return an empty Map if the wsdl document has no wsdl:service
118: */
119: @NotNull
120: Map<QName, ? extends WSDLService> getServices();
121:
122: /**
123: * Main purpose of this class is to parsing of a WSDL and get the {@link WSDLModel} from it.
124: */
125: public class WSDLParser {
126: /**
127: * Parses WSDL from the given wsdlLoc and gives a {@link WSDLModel} built from it.
128: *
129: * @param wsdlEntityParser Works like an entityResolver to resolve WSDLs
130: * @param resolver {@link XMLEntityResolver}, works at XML infoset level
131: * @param isClientSide true - its invoked on the client, false means its invoked on the server
132: * @param extensions var args of {@link com.sun.xml.ws.api.wsdl.parser.WSDLParserExtension}s
133: * @return A {@link WSDLModel} built from the given wsdlLocation}
134: * @throws java.io.IOException
135: * @throws javax.xml.stream.XMLStreamException
136: * @throws org.xml.sax.SAXException
137: */
138: public static @NotNull
139: WSDLModel parse(XMLEntityResolver.Parser wsdlEntityParser,
140: XMLEntityResolver resolver, boolean isClientSide,
141: WSDLParserExtension... extensions) throws IOException,
142: XMLStreamException, SAXException {
143: return RuntimeWSDLParser.parse(wsdlEntityParser, resolver,
144: isClientSide, extensions);
145: }
146: }
147: }
|