Package net.webpdf.wsclient.session.rest

Class AbstractRestSession<T_REST_DOCUMENT extends RestDocument>

java.lang.Object

net.webpdf.wsclient.session.AbstractSession

net.webpdf.wsclient.session.rest.AbstractRestSession<T_REST_DOCUMENT>

Type Parameters:

T_REST_DOCUMENT - The RestDocument type used by this RestSession.

All Implemented Interfaces:

AutoCloseable, RestSession<T_REST_DOCUMENT>, Session

Direct Known Subclasses:

RestWebServiceSession

public abstract class AbstractRestSession<T_REST_DOCUMENT extends RestDocument>
extends AbstractSession
implements RestSession<T_REST_DOCUMENT>

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	close()	Close the RestSession.
protected abstract @NotNull AdministrationManager<T_REST_DOCUMENT>	createAdministrationManager()	Creates a new AdministrationManager matching this RestSession.
protected abstract @NotNull DocumentManager<T_REST_DOCUMENT>	createDocumentManager()	Creates a new DocumentManager matching this RestSession.
@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.

Methods inherited from class net.webpdf.wsclient.session.AbstractSession

getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

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.rest.RestSession

createWebServiceInstance, uploadDocument, uploadDocument

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

getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

Constructor Detail

AbstractRestSession

public AbstractRestSession(@NotNull
                           @NotNull SessionContext serverContext,
                           @NotNull
                           @NotNull AuthProvider authProvider)
                    throws ResultException

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

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:

serverContext - The SessionContext initializing the SessionContextSettings of this RestSession.

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

Throws:

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

Method Detail

getHttpClient

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

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

Specified by:

getHttpClient in interface RestSession<T_REST_DOCUMENT extends RestDocument>

Returns:

The CloseableHttpClient connected to the webPDF server via this RestSession.

getDocumentManager

@NotNull
public @NotNull DocumentManager<T_REST_DOCUMENT> getDocumentManager()

Returns the active DocumentManager of this RestSession.

Specified by:

getDocumentManager in interface RestSession<T_REST_DOCUMENT extends RestDocument>

Returns:

The active DocumentManager of this RestSession.

getAdministrationManager

@NotNull
public @NotNull AdministrationManager<T_REST_DOCUMENT> getAdministrationManager()

Returns the active AdministrationManager of this RestSession.

Specified by:

getAdministrationManager in interface RestSession<T_REST_DOCUMENT extends RestDocument>

Returns:

The active AdministrationManager of this RestSession.

getUser

@Nullable
public @Nullable AuthUserCredentials getUser()

Returns the AuthUserCredentials logged in via this RestSession.

Specified by:

getUser in interface RestSession<T_REST_DOCUMENT extends RestDocument>

Returns:

The AuthUserCredentials logged in via this RestSession.

getCertificates

@Nullable
public @Nullable AuthUserCertificates getCertificates()

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

Specified by:

getCertificates in interface RestSession<T_REST_DOCUMENT extends RestDocument>

Returns:

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

updateCertificates

@Nullable
public @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.

Specified by:

updateCertificates in interface RestSession<T_REST_DOCUMENT extends RestDocument>

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.

close

public void close()
           throws ResultException

Close the RestSession.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Session

Throws:

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

createDocumentManager

@NotNull
protected abstract @NotNull DocumentManager<T_REST_DOCUMENT> createDocumentManager()

Creates a new DocumentManager matching this RestSession.

Returns:

The created DocumentManager.

createAdministrationManager

@NotNull
protected abstract @NotNull AdministrationManager<T_REST_DOCUMENT> createAdministrationManager()

Creates a new AdministrationManager matching this RestSession.

Returns:

The created AdministrationManager.