Package net.webpdf.wsclient.session

Class AbstractSession

java.lang.Object

net.webpdf.wsclient.session.AbstractSession

All Implemented Interfaces:

AutoCloseable, Session

Direct Known Subclasses:

AbstractRestSession, AbstractSoapSession

public abstract class AbstractSession
extends Object
implements Session

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

Constructor Summary

Constructors

Constructor	Description
AbstractSession(@NotNull WebServiceProtocol webServiceProtocol, @NotNull SessionContext serverContext, @NotNull AuthProvider authProvider)	Creates a new AbstractRestSession instance providing connection information and authorization objects for a webPDF server-client Session.

Method Summary

Modifier and Type	Method	Description
@NotNull AuthProvider	getAuthProvider()	Provides the AuthProvider for the authorization of the Session´s requests.
@NotNull SessionContextSettings	getSessionContext()	Returns the SessionContextSettings used for this session.
@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.hc.core5.http.NameValuePair> parameters)	Returns an URI pointing to the webservice interface of the session.
@NotNull WebServiceProtocol	getWebServiceProtocol()	Returns the WebServiceProtocol this Session is using.

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

close

Constructor Detail

AbstractSession

public AbstractSession(@NotNull
                       @NotNull WebServiceProtocol webServiceProtocol,
                       @NotNull
                       @NotNull SessionContext serverContext,
                       @NotNull
                       @NotNull AuthProvider authProvider)
                throws ResultException

Creates a new AbstractRestSession instance providing connection information and authorization objects for a webPDF server-client Session.

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:

webServiceProtocol - The WebServiceProtocol used for this Session.

serverContext - The SessionContext initializing the SessionContextSettings of this Session.

authProvider - The AuthProvider for authentication/authorization of this Session.

Throws:

ResultException - Shall be thrown, in case establishing the Session failed.

Method Detail

getAuthProvider

@NotNull
public @NotNull AuthProvider getAuthProvider()

Provides the AuthProvider for the authorization of the Session´s requests.

Specified by:

getAuthProvider in interface Session

Returns:

AuthProvider for the authorization of the Session´s requests.

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.

getSessionContext

@NotNull
public @NotNull SessionContextSettings getSessionContext()

Returns the SessionContextSettings used for this session.

Specified by:

getSessionContext in interface Session

Returns:

The SessionContextSettings used for this session.

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.hc.core5.http.NameValuePair> parameters)
                    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.

parameters - Additional Get parameters.

Returns:

an URI pointing to the webservice interface of the session.

Throws:

ResultException - a ResultException