Package net.webpdf.wsclient.session.rest

Class RestWebServiceSession

java.lang.Object

net.webpdf.wsclient.session.AbstractSession

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

net.webpdf.wsclient.session.rest.RestWebServiceSession

All Implemented Interfaces:

AutoCloseable, RestSession<RestWebServiceDocument>, Session

public class RestWebServiceSession
extends AbstractRestSession<RestWebServiceDocument>

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

Information: A RestWebServiceSession provides simplified access to the uploaded RestDocuments via a specialized RestWebServiceDocumentManager.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected @NotNull AdministrationManager<RestWebServiceDocument>	createAdministrationManager()	Creates a new AdministrationManager matching this RestSession.
protected @NotNull DocumentManager<RestWebServiceDocument>	createDocumentManager()	Creates a new RestWebServiceDocumentManager.
<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 RestWebServiceDocument	uploadDocument(@NotNull File source)	This is a shortcut for DocumentManager.uploadDocument(File) and uploads the given source to the webPDF server.
@NotNull RestWebServiceDocument	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 class net.webpdf.wsclient.session.rest.AbstractRestSession

close, getAdministrationManager, getCertificates, getDocumentManager, getHttpClient, getUser, updateCertificates

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.Session

getAuthProvider, getSessionContext, getURI, getURI, getWebServiceProtocol

Constructor Detail

RestWebServiceSession

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

Creates a new RestWebServiceSession instance providing connection information, authorization objects and a RestWebServiceDocumentManager 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 session failed.

Method Detail

uploadDocument

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

Throws:

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

uploadDocument

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

Throws:

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

createDocumentManager

@NotNull
protected @NotNull DocumentManager<RestWebServiceDocument> createDocumentManager()

Creates a new RestWebServiceDocumentManager.

Specified by:

createDocumentManager in class AbstractRestSession<RestWebServiceDocument>

Returns:

The created RestWebServiceDocumentManager.

createAdministrationManager

@NotNull
protected @NotNull AdministrationManager<RestWebServiceDocument> createAdministrationManager()

Creates a new AdministrationManager matching this RestSession.

Specified by:

createAdministrationManager in class AbstractRestSession<RestWebServiceDocument>

Returns:

The created AdministrationManager.

createWebServiceInstance

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