Module com.sun.xml.ws

Package com.sun.xml.ws.api.server

Class SDDocumentSource

java.lang.Object

com.sun.xml.ws.api.server.SDDocumentSource

Direct Known Subclasses:

SDDocumentImpl

public abstract class SDDocumentSource
extends Object

SPI that provides the source of SDDocument.

This abstract class could be implemented by applications, or one of the create(java.lang.Class<?>, java.lang.String) methods can be used.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SDDocumentSource()	Default constructor.

Method Summary

Modifier and Type	Method	Description
static SDDocumentSource	create(Class<?> implClass, String wsdlLocation)
static SDDocumentSource	create(URL url)	Creates SDDocumentSource from an URL.
static SDDocumentSource	create(URL systemId, com.sun.xml.stream.buffer.XMLStreamBuffer xsb)	Creates a SDDocumentSource from XMLStreamBuffer.
abstract URL	getSystemId()	System ID of this document.
abstract XMLStreamReader	read()	Returns the XMLStreamReader that reads the document.
abstract XMLStreamReader	read(XMLInputFactory xif)	Returns the XMLStreamReader that reads the document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SDDocumentSource

protected SDDocumentSource()

Default constructor.

Method Details

read

public abstract XMLStreamReader read(XMLInputFactory xif)
                              throws IOException,
XMLStreamException

Returns the XMLStreamReader that reads the document.

This method maybe invoked multiple times concurrently.

Parameters:

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.)

Returns:

The caller is responsible for closing the reader to avoid resource leak.

Throws:

XMLStreamException - if something goes wrong while creating a parser.

IOException - if something goes wrong trying to read the document.

read

public abstract XMLStreamReader read()
                              throws IOException,
XMLStreamException

Returns the XMLStreamReader that reads the document.

This method maybe invoked multiple times concurrently.

Returns:

The caller is responsible for closing the reader to avoid resource leak.

Throws:

XMLStreamException - if something goes wrong while creating a parser.

IOException - if something goes wrong trying to read the document.

getSystemId

public abstract URL getSystemId()

System ID of this document.

create

public static SDDocumentSource create(Class<?> implClass,
 String wsdlLocation)

create

public static SDDocumentSource create(URL url)

Creates SDDocumentSource from an URL.

create

public static SDDocumentSource create(URL systemId,
 com.sun.xml.stream.buffer.XMLStreamBuffer xsb)

Creates a SDDocumentSource from XMLStreamBuffer.