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

Interface SoapDocument

All Superinterfaces:

AutoCloseable, Document

All Known Implementing Classes:

SoapWebServiceDocument

public interface SoapDocument
extends Document, AutoCloseable

A class implementing SoapDocument represents a document, as it is processed/created by a SoapWebService.

Such a SoapDocument 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.

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 WebServiceProtocol.SOAP response document to the given OutputStream.

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

getSource, isFileSource

Method Detail

getSourceDataHandler

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

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

Returns:

A DataHandler for the document's source.

setResult

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

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

Parameters:

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

getResult

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

Returns:

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

writeResult

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

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

Parameters:

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

Throws:

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

writeResult

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

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

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

void close()
    throws ResultException

Closes the documents DataHandlers.

Specified by:

close in interface AutoCloseable

Throws:

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