Package net.webpdf.wsclient.session.soap

Interface SoapSession<T_SOAP_DOCUMENT extends SoapDocument>

Type Parameters:

T_SOAP_DOCUMENT - The RestDocument type used by this RestSession

All Superinterfaces:

AutoCloseable, Session

All Known Implementing Classes:

AbstractSoapSession, SoapWebServiceSession

public interface SoapSession<T_SOAP_DOCUMENT extends SoapDocument>
extends Session

A class implementing SoapSession establishes and manages a WebServiceProtocol.SOAP connection with a webPDF server.

Method Summary

Modifier and Type	Method	Description
T_SOAP_DOCUMENT	createDocument()	Creates a handle for a SoapWebService output without providing a source document. This is recommended for webservices, that don't require a source document.
T_SOAP_DOCUMENT	createDocument(@NotNull File source)	Creates a SoapDocument originating from the given File.
T_SOAP_DOCUMENT	createDocument(@NotNull InputStream source)	Creates a SoapDocument originating from the given InputStream. Be aware: This copies all remaining bytes from the given InputStream to an array, to create a reusable BinaryDataSource. Especially for large files using this is ill advised, using the alternative constructors createDocument(URI) or createDocument(File) is always recommended.
T_SOAP_DOCUMENT	createDocument(@NotNull URI source)	Creates a SoapDocument originating from the given URI.
<T_WEBSERVICE extends SoapWebService<?,?,?>> T_WEBSERVICE	createWebServiceInstance(@NotNull WebServiceType webServiceType)	Creates a matching SoapWebService instance to execute a webPDF operation for the current session.
boolean	isUseLocalWsdl()	When returning true, a wsdl stored on the local file system shall be used instead of the WSDL published by the webPDF server.
void	setUseLocalWsdl(boolean useLocalWsdl)	When set to true, a wsdl stored on the local file system shall be used instead of the WSDL published by the webPDF server.

Methods inherited from interface net.webpdf.wsclient.session.Session

close, getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

Method Detail

isUseLocalWsdl

boolean isUseLocalWsdl()

When returning true, a wsdl stored on the local file system shall be used instead of the WSDL published by the webPDF server.

Returns:

true, if a wsdl stored on the local file system shall be used instead of the WSDL published by the webPDF server.

setUseLocalWsdl

void setUseLocalWsdl(boolean useLocalWsdl)

When set to true, a wsdl stored on the local file system shall be used instead of the WSDL published by the webPDF server.

Parameters:

useLocalWsdl - true, to use a wsdl stored on the local file system, instead of the WSDL published by the webPDF server.

createDocument

@NotNull
T_SOAP_DOCUMENT createDocument()

Creates a handle for a SoapWebService output without providing a source document.
This 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.

createDocument

@NotNull
T_SOAP_DOCUMENT createDocument(@NotNull
                               @NotNull InputStream source)
                        throws ResultException

Creates a SoapDocument originating from the given InputStream.
Be aware: This copies all remaining bytes from the given InputStream to an array, to create a reusable BinaryDataSource.
Especially for large files using this is ill advised, using the alternative constructors createDocument(URI) or createDocument(File) is always recommended.

Parameters:

source - The URI the SoapDocument is originating from.

Throws:

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

createDocument

@NotNull
T_SOAP_DOCUMENT createDocument(@NotNull
                               @NotNull URI source)
                        throws ResultException

Creates a SoapDocument originating from the given URI.

Parameters:

source - The URI the SoapDocument is originating from.

Throws:

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

createDocument

@NotNull
T_SOAP_DOCUMENT createDocument(@NotNull
                               @NotNull File source)
                        throws ResultException

Creates a SoapDocument originating from the given File.

Parameters:

source - The File the SoapDocument is originating from.

Throws:

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

createWebServiceInstance

@NotNull
<T_WEBSERVICE extends SoapWebService<?,?,?>> T_WEBSERVICE createWebServiceInstance(@NotNull
                                                                                               @NotNull WebServiceType webServiceType)
                                                                                        throws ResultException

Creates a matching SoapWebService instance to execute a webPDF operation for the current session.

Type Parameters:

T_WEBSERVICE - The WebServiceType to create an interface for.

Parameters:

webServiceType - The WebServiceType to create an interface for.

Returns:

A matching SoapWebService instance.

Throws:

ResultException - Shall be thrown, if the SoapWebService creation failed.