com.sun.xml.ws.api.server.SDDocumentSource Maven / Gradle / Ivy
Show all versions of webservices-osgi Show documentation
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.ws.api.server;
import com.sun.xml.stream.buffer.XMLStreamBuffer;
import com.sun.xml.ws.api.streaming.XMLStreamReaderFactory;
import com.sun.xml.ws.server.ServerRtException;
import com.sun.xml.ws.streaming.TidyXMLStreamReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
/**
* SPI that provides the source of {@link SDDocument}.
*
*
* This abstract class could be implemented by applications, or one of the
* {@link #create} methods can be used.
*
* @author Kohsuke Kawaguchi
*/
public abstract class SDDocumentSource {
/**
* Default constructor.
*/
protected SDDocumentSource() {}
/**
* Returns the {@link XMLStreamReader} that reads the document.
*
*
* This method maybe invoked multiple times concurrently.
*
* @param xif
* The implementation may choose to use this object when it wants to
* create a new parser (or it can just ignore this parameter completely.)
* @return
* The caller is responsible for closing the reader to avoid resource leak.
*
* @throws XMLStreamException
* if something goes wrong while creating a parser.
* @throws IOException
* if something goes wrong trying to read the document.
*/
public abstract XMLStreamReader read(XMLInputFactory xif) throws IOException, XMLStreamException;
/**
* Returns the {@link XMLStreamReader} that reads the document.
*
*
* This method maybe invoked multiple times concurrently.
*
* @return
* The caller is responsible for closing the reader to avoid resource leak.
*
* @throws XMLStreamException
* if something goes wrong while creating a parser.
* @throws IOException
* if something goes wrong trying to read the document.
*/
public abstract XMLStreamReader read() throws IOException, XMLStreamException;
/**
* System ID of this document.
*/
public abstract URL getSystemId();
public static SDDocumentSource create(final Class implClass, final String wsdlLocation) {
ClassLoader cl = implClass.getClassLoader();
URL url = cl.getResource(wsdlLocation);
if (url != null) {
return create(url);
} else {
return create(wsdlLocation, implClass);
}
}
/**
* Creates {@link SDDocumentSource} from an URL.
*/
public static SDDocumentSource create(final URL url) {
return new SDDocumentSource() {
private final URL systemId = url;
@Override
public XMLStreamReader read(XMLInputFactory xif) throws IOException, XMLStreamException {
InputStream is = url.openStream();
return new TidyXMLStreamReader(
xif.createXMLStreamReader(systemId.toExternalForm(),is), is);
}
@Override
public XMLStreamReader read() throws IOException, XMLStreamException {
InputStream is = url.openStream();
return new TidyXMLStreamReader(
XMLStreamReaderFactory.create(systemId.toExternalForm(),is,false), is);
}
@Override
public URL getSystemId() {
return systemId;
}
};
}
/**
* Creates {@link SDDocumentSource} from resource path using resolvingClass to read the resource.
* Required for Jigsaw runtime.
*
* @param resolvingClass class used to read resource
* @param path resource path
*/
private static SDDocumentSource create(final String path, final Class resolvingClass) {
return new SDDocumentSource() {
@Override
public XMLStreamReader read(XMLInputFactory xif) throws IOException, XMLStreamException {
InputStream is = inputStream();
return new TidyXMLStreamReader(xif.createXMLStreamReader(path,is), is);
}
@Override
public XMLStreamReader read() throws IOException, XMLStreamException {
InputStream is = inputStream();
return new TidyXMLStreamReader(XMLStreamReaderFactory.create(path,is,false), is);
}
@Override
public URL getSystemId() {
try {
return new URL("file://" + path);
} catch (MalformedURLException e) {
return null;
}
}
private InputStream inputStream() throws IOException {
java.lang.Module module = resolvingClass.getModule();
InputStream stream = module.getResourceAsStream(path);
if (stream != null) {
return stream;
}
throw new ServerRtException("cannot.load.wsdl", path);
}
};
}
/**
* Creates a {@link SDDocumentSource} from {@link XMLStreamBuffer}.
*/
public static SDDocumentSource create(final URL systemId, final XMLStreamBuffer xsb) {
return new SDDocumentSource() {
@Override
public XMLStreamReader read(XMLInputFactory xif) throws XMLStreamException {
return xsb.readAsXMLStreamReader();
}
@Override
public XMLStreamReader read() throws XMLStreamException {
return xsb.readAsXMLStreamReader();
}
@Override
public URL getSystemId() {
return systemId;
}
};
}
}