Package net.webpdf.wsclient.session.soap

Class SoapWebServiceSession

java.lang.Object

net.webpdf.wsclient.session.AbstractSession

net.webpdf.wsclient.session.soap.AbstractSoapSession<SoapWebServiceDocument>

net.webpdf.wsclient.session.soap.SoapWebServiceSession

All Implemented Interfaces:

AutoCloseable, Session, SoapSession<SoapWebServiceDocument>

public class SoapWebServiceSession
extends AbstractSoapSession<SoapWebServiceDocument>

An instance of SoapWebServiceSession establishes and manages a WebServiceProtocol.SOAP connection with a webPDF server.

Constructor Summary

Constructors

Constructor	Description
SoapWebServiceSession(@NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)	Creates a new SoapWebServiceSession instance providing connection information, authorization objects for a webPDF server-client SoapSession.

Method Summary

Modifier and Type	Method	Description
@NotNull SoapWebServiceDocument	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.
@NotNull SoapWebServiceDocument	createDocument(@NotNull File source)	Creates a SoapDocument originating from the given File.
@NotNull SoapWebServiceDocument	createDocument(@NotNull InputStream source)	Creates a SoapDocument originating from the given InputStream.
@NotNull SoapWebServiceDocument	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.

Methods inherited from class net.webpdf.wsclient.session.soap.AbstractSoapSession

close, isUseLocalWsdl, setUseLocalWsdl

Methods inherited from class net.webpdf.wsclient.session.AbstractSession

getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

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

getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

Constructor Detail

SoapWebServiceSession

public SoapWebServiceSession(@NotNull
                             @NotNull SessionContext serverContext,
                             @NotNull
                             @NotNull AuthProvider authProvider)
                      throws ResultException

Creates a new SoapWebServiceSession instance providing connection information, authorization objects for a webPDF server-client SoapSession.

Be Aware: Neither SessionContext, nor AuthProvider are required to serve multiple Sessions at a time. It is expected to create a new SessionContext and AuthProvider per Session you create.

Parameters:

serverContext - The SessionContext initializing the SessionContextSettings of this SoapSession.

authProvider - The AuthProvider for authentication/authorization of this SoapSession.

Throws:

ResultException - Shall be thrown, in case establishing the session failed.

Method Detail

createWebServiceInstance

@NotNull
public <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.

createDocument

@NotNull
public @NotNull SoapWebServiceDocument 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
public @NotNull SoapWebServiceDocument createDocument(@NotNull
                                                      @NotNull InputStream source)
                                               throws ResultException

Creates a SoapDocument originating from the given InputStream.

Parameters:

source - The URI the SoapDocument is originating from.

Throws:

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

createDocument

@NotNull
public @NotNull SoapWebServiceDocument 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
public @NotNull SoapWebServiceDocument 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.