Package net.webpdf.wsclient.session.soap.documents

Class SoapWebServiceDocument

java.lang.Object

net.webpdf.wsclient.session.documents.AbstractDocument

net.webpdf.wsclient.session.soap.documents.SoapWebServiceDocument

All Implemented Interfaces:

AutoCloseable, Document, SoapDocument

public class SoapWebServiceDocument
extends AbstractDocument
implements SoapDocument

An instance of SoapWebServiceDocument represents a document, as it is processed/created by a SoapWebService.

Such a SoapWebServiceDocument defines a source for the document, that shall be processed by a called SoapWebService and a target resource for the document produced by that webservice.

Be aware: A SoapDocument is using DataHandlers, that might require closing to prevent resource leaks. You should always close() SoapDocuments.

Constructor Summary

Constructors

Constructor	Description
SoapWebServiceDocument()	Creates a handle for a SoapWebService output without providing a source document. This shall always return null, in case getSourceDataHandler() is called and is recommended for webservices, that don't require a source document.
SoapWebServiceDocument(@NotNull File source)	Manages a SoapDocument originating from the given File.
SoapWebServiceDocument(@NotNull InputStream source)	Manages a SoapDocument originating from the given InputStream.
SoapWebServiceDocument(@NotNull URI source)	Manages a SoapDocument originating from the given URI.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the documents DataHandlers.
@Nullable jakarta.activation.DataHandler	getResult()	Returns the result DataHandler, that represents the current result of a SoapWebService call for this SoapDocument.
@Nullable jakarta.activation.DataHandler	getSourceDataHandler()	Returns a DataHandler for the document's source - may return null in case no source document has been selected.
void	setResult(@Nullable jakarta.activation.DataHandler result)	Sets the result DataHandler, that represents the current result of a SoapWebService call for this SoapDocument.
void	writeResult(@NotNull File target)	Attempts to write the WebServiceProtocol.SOAP response document to the given File.
void	writeResult(@NotNull OutputStream target)	Attempts to write the response SoapDocument to the given DataHandler.

Methods inherited from class net.webpdf.wsclient.session.documents.AbstractDocument

getSource, isFileSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.webpdf.wsclient.session.documents.Document

getSource, isFileSource

Constructor Detail

SoapWebServiceDocument

public SoapWebServiceDocument()

Creates a handle for a SoapWebService output without providing a source document.
This shall always return null, in case getSourceDataHandler() is called and is recommended for webservices, that don't require a source document. (Such as the URL-Converter.)

Be aware: Most webservices require a source document, with few exceptions. Before using this, make sure that this is valid for the WebService call you intend to execute.

Be aware: A SoapDocument is using DataHandlers, that might require closing to prevent resource leaks. You should always close() SoapDocuments.

SoapWebServiceDocument

public SoapWebServiceDocument(@NotNull
                              @NotNull InputStream source)
                       throws ResultException

Manages a SoapDocument originating from the given InputStream.

Be aware: A SoapDocument is using DataHandlers, that might require closing to prevent resource leaks. You should always close() SoapDocuments.

Parameters:

source - The URI the SoapDocument is originating from.

Throws:

ResultException - Shall be thrown in case loading the source document failed.

SoapWebServiceDocument

public SoapWebServiceDocument(@NotNull
                              @NotNull URI source)
                       throws ResultException

Manages a SoapDocument originating from the given URI.

Be aware: A SoapDocument is using DataHandlers, that might require closing to prevent resource leaks. You should always close() SoapDocuments.

Parameters:

source - The URI the SoapDocument is originating from.

Throws:

ResultException - Shall be thrown in case loading the source document failed.

SoapWebServiceDocument

public SoapWebServiceDocument(@NotNull
                              @NotNull File source)
                       throws ResultException

Manages a SoapDocument originating from the given File.

Be aware: A SoapDocument is using DataHandlers, that might require closing to prevent resource leaks. You should always close() SoapDocuments.

Parameters:

source - The File the SoapDocument is originating from.

Throws:

ResultException - Shall be thrown in case loading the source document failed.

Method Detail

getSourceDataHandler

@Nullable
public @Nullable jakarta.activation.DataHandler getSourceDataHandler()

Returns a DataHandler for the document's source - may return null in case no source document has been selected.

Specified by:

getSourceDataHandler in interface SoapDocument

Returns:

A DataHandler for the document's source.

setResult

public void setResult(@Nullable
                      @Nullable jakarta.activation.DataHandler result)

Sets the result DataHandler, that represents the current result of a SoapWebService call for this SoapDocument.

Specified by:

setResult in interface SoapDocument

Parameters:

result - The result DataHandler, that represents the current result of a SoapWebService call.

getResult

@Nullable
public @Nullable jakarta.activation.DataHandler getResult()

Returns the result DataHandler, that represents the current result of a SoapWebService call for this SoapDocument. (May return null, should such a result not exist.)

Specified by:

getResult in interface SoapDocument

Returns:

The result DataHandler, that represents the current result of a SoapWebService call.

writeResult

public void writeResult(@NotNull
                        @NotNull OutputStream target)
                 throws ResultException

Attempts to write the response SoapDocument to the given DataHandler.

Specified by:

writeResult in interface SoapDocument

Parameters:

target - The OutputStream the response SoapDocument shall be written to.

Throws:

ResultException - Shall be thrown, should writing the result document fail.

writeResult

public void writeResult(@NotNull
                        @NotNull File target)
                 throws ResultException

Attempts to write the WebServiceProtocol.SOAP response document to the given File.

Specified by:

writeResult in interface SoapDocument

Parameters:

target - The target File the WebServiceProtocol.SOAP response document shall be written to.

Throws:

ResultException - Shall be thrown, should writing the result document fail.

close

public void close()
           throws ResultException

Closes the documents DataHandlers.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SoapDocument

Throws:

ResultException - Shall be thrown, when closing the underlying DataHandlers failed.