Package net.webpdf.wsclient.session

Interface Session

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

RestSession<T_REST_DOCUMENT>, SoapSession<T_SOAP_DOCUMENT>

All Known Implementing Classes:

AbstractRestSession, AbstractSession, AbstractSoapSession, RestWebServiceSession, SoapWebServiceSession

public interface Session
extends AutoCloseable

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

Method Summary

Modifier and Type	Method	Description
void	close()	Close the Session.
@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, List<org.apache.hc.core5.http.NameValuePair> parameters)	Returns an URI pointing to the webservice interface of the session.
@NotNull URI	getURI(String subPath)	Returns an URI pointing to the webservice interface of the session.
@NotNull WebServiceProtocol	getWebServiceProtocol()	Returns the WebServiceProtocol this Session is using.

Method Detail

getWebServiceProtocol

@NotNull
@NotNull WebServiceProtocol getWebServiceProtocol()

Returns the WebServiceProtocol this Session is using.

Returns:

The WebServiceProtocol this Session is using.

getSessionContext

@NotNull
@NotNull SessionContextSettings getSessionContext()

Returns the SessionContextSettings used for this session.

Returns:

The SessionContextSettings used for this session.

getAuthProvider

@NotNull
@NotNull AuthProvider getAuthProvider()

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

Returns:

AuthProvider for the authorization of the Session´s requests.

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

getURI

@NotNull
@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.

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

close

void close()
    throws ResultException

Close the Session.

Specified by:

close in interface AutoCloseable

Throws:

ResultException - Shall be thrown, if closing the Session failed.