net.webpdf.wsclient.session

Class RestSession

java.lang.Object

net.webpdf.wsclient.session.RestSession

All Implemented Interfaces:

AutoCloseable, Session

public class RestSession
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close session on webPDF server
org.apache.http.auth.Credentials	getCredentials() Returns the Credentials authorizing this session.
DataFormat	getDataFormat() Returns the DataFormat accepted by this session.
DocumentManager	getDocumentManager() Returns the DocumentManager managing source and target document for this session.
org.apache.http.impl.client.CloseableHttpClient	getHttpClient() Returns the CloseableHttpClient connected to the server via this session.
TLSContext	getTlsContext() Returns the currently set TLS context.
Token	getToken() Returns the session Token of this session.
URI	getURI(String subPath) Returns an URI pointing to the webservice interface of the session.
WebServiceProtocol	getWebServiceProtocol() Returns the WebServiceProtocol this session is using.
void	login() Login into the server and get a token
void	setCredentials(org.apache.http.auth.Credentials credentials) Sets the Credentials authorizing this session.
void	setDataFormat(DataFormat dataFormat) Sets the DataFormat accepted by this session.

Methods inherited from class java.lang.Object

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

Method Detail

getToken

public Token getToken()

Returns the session Token of this session.

Returns:

The session Token of this session.

getHttpClient

public org.apache.http.impl.client.CloseableHttpClient getHttpClient()

Returns the CloseableHttpClient connected to the server via this session.

Returns:

The CloseableHttpClient connected to the server via this session.

getDocumentManager

public DocumentManager getDocumentManager()

Returns the DocumentManager managing source and target document for this session.

Returns:

The DocumentManager managing source and target document for this session.

setDataFormat

public void setDataFormat(DataFormat dataFormat)

Sets the DataFormat accepted by this session.

Parameters:

dataFormat - The DataFormat accepted by this session.

close

public void close()
           throws IOException

Close session on webPDF server

Throws:

IOException - a IOException

login

public void login()
           throws IOException

Login into the server and get a token

Throws:

IOException - HTTP access error

getTlsContext

public TLSContext getTlsContext()

Returns the currently set TLS context.

Specified by:

getTlsContext in interface Session

Returns:

The currently set TLS context.

getWebServiceProtocol

public WebServiceProtocol getWebServiceProtocol()

Returns the WebServiceProtocol this session is using.

Specified by:

getWebServiceProtocol in interface Session

Returns:

The WebServiceProtocol this session is using.

getURI

public URI getURI(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

getCredentials

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

public DataFormat getDataFormat()

Returns the DataFormat accepted by this session.

Specified by:

getDataFormat in interface Session

Returns:

The DataFormat accepted by this session.