net.webpdf.wsclient.session

Interface Session

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RestSession, SoapSession

public interface Session
extends AutoCloseable

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Terminates the current session.
org.apache.http.auth.Credentials	getCredentials() Returns the Credentials authorizing this session.
DataFormat	getDataFormat() Returns the DataFormat accepted by this session.
TLSContext	getTlsContext() Returns the currently set TLS context.
URI	getURI(String subPath) Returns an URI pointing to the webservice interface of the session.
WebServiceProtocol	getWebServiceProtocol() Returns the WebServiceProtocol of this session.
void	setCredentials(org.apache.http.auth.Credentials userCredentials) Sets the Credentials authorizing this session.

Method Detail

getTlsContext

TLSContext getTlsContext()

Returns the currently set TLS context.

Returns:

The currently set TLS context.

close

void close()
           throws IOException

Terminates the current session.

Specified by:

close in interface AutoCloseable

Throws:

IOException - an IOException

getWebServiceProtocol

WebServiceProtocol getWebServiceProtocol()

Returns the WebServiceProtocol of this session.

Returns:

The WebServiceProtocol of this session.

getURI

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

DataFormat getDataFormat()

Returns the DataFormat accepted by this session.

Returns:

The DataFormat accepted by this session.

getCredentials

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

Returns the Credentials authorizing this session.

Returns:

The Credentials authorizing this session.

setCredentials

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

Sets the Credentials authorizing this session.

Parameters:

userCredentials - The Credentials authorizing this session.