Package net.webpdf.wsclient.session.rest

Interface RestSession<T_REST_DOCUMENT extends RestDocument>

Type Parameters:

T_REST_DOCUMENT - The RestDocument type used by this RestSession

All Superinterfaces:

AutoCloseable, Session

All Known Implementing Classes:

AbstractRestSession, RestWebServiceSession

public interface RestSession<T_REST_DOCUMENT extends RestDocument>
extends Session

A class implementing RestSession establishes and manages a WebServiceProtocol.REST connection with a webPDF server.

Information: A RestSession provides simplified access to the uploaded RestDocuments via a DocumentManager.

Method Summary

Modifier and Type	Method	Description
<T_WEBSERVICE extends RestWebService<?,?,?>> T_WEBSERVICE	createWebServiceInstance(@NotNull WebServiceType webServiceType)	Creates a matching RestWebService instance to execute a webPDF operation for the current session.
@NotNull AdministrationManager<T_REST_DOCUMENT>	getAdministrationManager()	Returns the active AdministrationManager of this RestSession.
@Nullable AuthUserCertificates	getCertificates()	Returns the AuthUserCertificates of the currently logged-in user of this RestSession.
@NotNull DocumentManager<T_REST_DOCUMENT>	getDocumentManager()	Returns the active DocumentManager of this RestSession.
@NotNull org.apache.hc.client5.http.impl.classic.CloseableHttpClient	getHttpClient()	Returns the CloseableHttpClient connected to the webPDF server via this RestSession.
@Nullable AuthUserCredentials	getUser()	Returns the AuthUserCredentials logged in via this RestSession.
@Nullable AuthUserCertificates	updateCertificates(String keystoreName, KeyStorePassword keyStorePassword)	Updates the KeyStorePasswords for specific keystore and returns the AuthUserCertificates for the currently logged-in user afterward.
T_REST_DOCUMENT	uploadDocument(@NotNull File source)	This is a shortcut for DocumentManager.uploadDocument(File) and uploads the given source to the webPDF server.
T_REST_DOCUMENT	uploadDocument(@NotNull InputStream source, @NotNull String documentName)	This is a shortcut for DocumentManager.uploadDocument(InputStream, String) and uploads the given source to the webPDF server.

Methods inherited from interface net.webpdf.wsclient.session.Session

close, getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

Method Detail

getHttpClient

@NotNull
@NotNull org.apache.hc.client5.http.impl.classic.CloseableHttpClient getHttpClient()

Returns the CloseableHttpClient connected to the webPDF server via this RestSession.

Returns:

The CloseableHttpClient connected to the webPDF server via this RestSession.

getDocumentManager

@NotNull
@NotNull DocumentManager<T_REST_DOCUMENT> getDocumentManager()

Returns the active DocumentManager of this RestSession.

Returns:

The active DocumentManager of this RestSession.

uploadDocument

@NotNull
T_REST_DOCUMENT uploadDocument(@NotNull
                               @NotNull InputStream source,
                               @NotNull
                               @NotNull String documentName)
                        throws ResultException

This is a shortcut for DocumentManager.uploadDocument(InputStream, String) and uploads the given source to the webPDF server.

Parameters:

source - The InputStream to upload to the webPDF server.

Returns:

The uploaded RestSession.

Throws:

ResultException - Shall be thrown, should the upload have failed.

uploadDocument

@NotNull
T_REST_DOCUMENT uploadDocument(@NotNull
                               @NotNull File source)
                        throws ResultException

This is a shortcut for DocumentManager.uploadDocument(File) and uploads the given source to the webPDF server.

Parameters:

source - The InputStream to upload to the webPDF server.

Returns:

The uploaded RestSession.

Throws:

ResultException - Shall be thrown, should the upload have failed.

getAdministrationManager

@NotNull
@NotNull AdministrationManager<T_REST_DOCUMENT> getAdministrationManager()

Returns the active AdministrationManager of this RestSession.

Returns:

The active AdministrationManager of this RestSession.

getUser

@Nullable
@Nullable AuthUserCredentials getUser()

Returns the AuthUserCredentials logged in via this RestSession.

Returns:

The AuthUserCredentials logged in via this RestSession.

getCertificates

@Nullable
@Nullable AuthUserCertificates getCertificates()

Returns the AuthUserCertificates of the currently logged-in user of this RestSession.

Returns:

The AuthUserCertificates of the currently logged-in user of this RestSession.

updateCertificates

@Nullable
@Nullable AuthUserCertificates updateCertificates(String keystoreName,
                                                  KeyStorePassword keyStorePassword)
                                           throws ResultException

Updates the KeyStorePasswords for specific keystore and returns the AuthUserCertificates for the currently logged-in user afterward.

Parameters:

keystoreName - The name of the keystore to be updated.

keyStorePassword - The KeyStorePassword to unlock the certificates with.

Returns:

The AuthUserCertificates of the logged-in user in this RestSession.

Throws:

ResultException - Shall be thrown, if the request failed.

createWebServiceInstance

@NotNull
<T_WEBSERVICE extends RestWebService<?,?,?>> T_WEBSERVICE createWebServiceInstance(@NotNull
                                                                                               @NotNull WebServiceType webServiceType)
                                                                                        throws ResultException

Creates a matching RestWebService instance to execute a webPDF operation for the current session.

Type Parameters:

T_WEBSERVICE - The WebServiceType to create an interface for.

Parameters:

webServiceType - The WebServiceType to create an interface for.

Returns:

A matching RestWebService instance.

Throws:

ResultException - Shall be thrown, if the RestWebService creation failed.