net.webpdf.wsclient.session

Interface Session

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RestSession, SoapSession

public interface Session
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close() Terminates the current session.
@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(String subPath) Returns an URI pointing to the webservice interface of the session.
@NotNull WebServiceProtocol	getWebServiceProtocol() Returns the WebServiceProtocol of this session.
void	setCredentials(@Nullable org.apache.http.auth.Credentials userCredentials) Sets the Credentials authorizing this session.
void	setProxy(@Nullable ProxyConfiguration proxy) Set a ProxyConfiguration.

Method Detail

getTlsContext

@Nullable
@Nullable TLSContext getTlsContext()

Returns the currently set TLS context.

Returns:

The currently set TLS context.

getProxy

@Nullable
@Nullable ProxyConfiguration getProxy()

Returns the currently set ProxyConfiguration.

Returns:

The currently set ProxyConfiguration.

setProxy

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

Set a ProxyConfiguration.

Parameters:

proxy - The ProxyConfiguration, that shall be set.

Throws:

ResultException

close

void close()
    throws IOException

Terminates the current session.

Specified by:

close in interface AutoCloseable

Throws:

IOException - an IOException

getWebServiceProtocol

@NotNull
@NotNull WebServiceProtocol getWebServiceProtocol()

Returns the WebServiceProtocol of this session.

Returns:

The WebServiceProtocol of this session.

getURI

@NotNull
@NotNull URI getURI(String subPath)
                       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.

Returns:

an URI pointing to the webservice interface of the session.

Throws:

ResultException - a ResultException

getDataFormat

@Nullable
@Nullable DataFormat getDataFormat()

Returns the DataFormat accepted by this session.

Returns:

The DataFormat accepted by this session.

getCredentials

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

Returns the Credentials authorizing this session.

Returns:

The Credentials authorizing this session.

setCredentials

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

Sets the Credentials authorizing this session.

Parameters:

userCredentials - The Credentials authorizing this session.