net.webpdf.wsclient.session

Class SoapSession

java.lang.Object

net.webpdf.wsclient.session.SoapSession

All Implemented Interfaces:

AutoCloseable, Session

public class SoapSession
extends Object

Method Summary

Modifier and Type	Method and Description
void	close() Close session on webPDF server.
@Nullable org.apache.http.auth.Credentials	getCredentials() Returns the Credentials authorizing this session.
@Nullable DataFormat	getDataFormat() Returns the DataFormat accepted by this session.
@Nullable ProxyConfiguration	getProxy() Returns the currently set ProxyConfiguration.
@Nullable TLSContext	getTlsContext() Returns the currently set TLS context.
@NotNull URI	getURI(@NotNull String subPath) Returns an URI pointing to the webservice interface of the session.
@NotNull URI	getURI(@NotNull String subPath, List<org.apache.http.NameValuePair> parameters) Returns an URI pointing to the webservice interface of the session.
@NotNull WebServiceProtocol	getWebServiceProtocol() Returns the WebServiceProtocol this session is using.
boolean	isUseLocalWsdl() When returning true, a wsdl stored on the local file system shall be used instead of the WSDL published by the server.
void	setCredentials(@Nullable org.apache.http.auth.Credentials credentials) Sets the Credentials authorizing this session.
void	setProxy(@Nullable ProxyConfiguration proxy) Set a ProxyConfiguration.

Methods inherited from class java.lang.Object

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

Method Detail

setProxy

public void setProxy(@Nullable
                     @Nullable ProxyConfiguration proxy)
              throws ResultException

Set a ProxyConfiguration.

Specified by:

setProxy in interface Session

Parameters:

proxy - The ProxyConfiguration, that shall be set.

Throws:

ResultException - Shall be thrown, when resolving the proxy failed.

close

public void close()

Close session on webPDF server.

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

Returns:

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

getTlsContext

@Nullable
public @Nullable TLSContext getTlsContext()

Returns the currently set TLS context.

Specified by:

getTlsContext in interface Session

Returns:

The currently set TLS context.

getProxy

@Nullable
public @Nullable ProxyConfiguration getProxy()

Returns the currently set ProxyConfiguration.

Specified by:

getProxy in interface Session

Returns:

The currently set ProxyConfiguration.

getWebServiceProtocol

@NotNull
public @NotNull WebServiceProtocol getWebServiceProtocol()

Returns the WebServiceProtocol this session is using.

Specified by:

getWebServiceProtocol in interface Session

Returns:

The WebServiceProtocol this session is using.

getURI

@NotNull
public @NotNull URI getURI(@NotNull
                                     @NotNull String subPath)
                              throws ResultException

Returns an URI pointing to the webservice interface of the session.

Specified by:

getURI in interface Session

Parameters:

subPath - The location of the webservice interface on the webPDF server.

Returns:

an URI pointing to the webservice interface of the session.

Throws:

ResultException - a ResultException

getURI

@NotNull
public @NotNull URI getURI(@NotNull
                                     @NotNull String subPath,
                                     List<org.apache.http.NameValuePair> parameters)
                              throws ResultException

Returns an URI pointing to the webservice interface of the session.

Parameters:

subPath - The location of the webservice interface on the webPDF server.

parameters - Additional Get parameters.

Returns:

an URI pointing to the webservice interface of the session.

Throws:

ResultException - a ResultException

getCredentials

@Nullable
public @Nullable org.apache.http.auth.Credentials getCredentials()

Returns the Credentials authorizing this session.

Specified by:

getCredentials in interface Session

Returns:

The Credentials authorizing this session.

setCredentials

public void setCredentials(@Nullable
                           @Nullable org.apache.http.auth.Credentials credentials)

Sets the Credentials authorizing this session.

Specified by:

setCredentials in interface Session

Parameters:

credentials - The Credentials authorizing this session.

getDataFormat

@Nullable
public @Nullable DataFormat getDataFormat()

Returns the DataFormat accepted by this session.

Specified by:

getDataFormat in interface Session

Returns:

The DataFormat accepted by this session.