com.sun.xml.ws.util.MetadataUtil Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.util;
import com.sun.istack.NotNull;
import com.sun.xml.ws.api.server.SDDocument;
import com.sun.xml.ws.server.SDDocumentImpl;
import org.xml.sax.EntityResolver;
import java.util.*;
/**
* WSDL, schema document metadata utility class.
*
* @author Jitendra Kotamraju
*/
public class MetadataUtil {
/**
* Gets closure of all the referenced documents from the primary document(typically
* the service WSDL). It traverses the WSDL and schema imports and builds a closure
* set of documents.
*
* @param systemId primary wsdl or the any root document
* @param resolver used to get SDDocumentImpl for a document
* @param onlyTopLevelSchemas if true, the imported schemas from a schema would be ignored
* @return all the documents
*/
public static Map getMetadataClosure(@NotNull String systemId,
@NotNull MetadataResolver resolver, boolean onlyTopLevelSchemas) {
Map closureDocs = new HashMap();
Set remaining = new HashSet();
remaining.add(systemId);
while(!remaining.isEmpty()) {
Iterator it = remaining.iterator();
String current = it.next();
remaining.remove(current);
SDDocument currentDoc = resolver.resolveEntity(current);
SDDocument old = closureDocs.put(currentDoc.getURL().toExternalForm(), currentDoc);
assert old == null;
Set imports = currentDoc.getImports();
if (!currentDoc.isSchema() || !onlyTopLevelSchemas) {
for(String importedDoc : imports) {
if (closureDocs.get(importedDoc) == null) {
remaining.add(importedDoc);
}
}
}
}
return closureDocs;
}
public interface MetadataResolver {
/**
* returns {@link SDDocumentImpl} for the give systemId. It
* parses the document and categorises as WSDL, schema etc.
* The implementation could use a catlog resolver or an entity
* resolver {@link EntityResolver} before parsing.
*
* @param systemId document's systemId
* @return document for the systemId
*/
@NotNull SDDocument resolveEntity(String systemId);
}
}