Package net.webpdf.wsclient.session.soap

Class AbstractSoapSession<T_SOAP_DOCUMENT extends SoapDocument>

java.lang.Object

net.webpdf.wsclient.session.AbstractSession

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

All Implemented Interfaces:

AutoCloseable, Session, SoapSession<T_SOAP_DOCUMENT>

Direct Known Subclasses:

SoapWebServiceSession

public abstract class AbstractSoapSession<T_SOAP_DOCUMENT extends SoapDocument>
extends AbstractSession
implements SoapSession<T_SOAP_DOCUMENT>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()	Close the SoapSession.
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 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

Methods inherited from interface net.webpdf.wsclient.session.soap.SoapSession

createDocument, createDocument, createDocument, createDocument, createWebServiceInstance

Constructor Detail

AbstractSoapSession

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

Creates a new AbstractSoapSession instance providing connection information and 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 SoapSession failed.

Method Detail

isUseLocalWsdl

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

Specified by:

isUseLocalWsdl in interface SoapSession<T_SOAP_DOCUMENT extends SoapDocument>

Returns:

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

setUseLocalWsdl

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

Specified by:

setUseLocalWsdl in interface SoapSession<T_SOAP_DOCUMENT extends SoapDocument>

Parameters:

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

close

public void close()

Close the SoapSession.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session