Package net.webpdf.wsclient.session.rest.documents

Class AbstractDocumentManager<T_REST_DOCUMENT extends RestDocument>

java.lang.Object

net.webpdf.wsclient.session.rest.documents.AbstractDocumentManager<T_REST_DOCUMENT>

Type Parameters:

T_REST_DOCUMENT - The RestDocument type managed by the AbstractDocumentManager.

All Implemented Interfaces:

DocumentManager<T_REST_DOCUMENT>

Direct Known Subclasses:

RestWebServiceDocumentManager

public abstract class AbstractDocumentManager<T_REST_DOCUMENT extends RestDocument>
extends Object
implements DocumentManager<T_REST_DOCUMENT>

An instance of AbstractDocumentManager allows to monitor and interact with the RestDocuments uploaded to a RestSession of the webPDF server.

Constructor Summary

Constructors

Constructor	Description
AbstractDocumentManager(@NotNull RestSession<T_REST_DOCUMENT> session)	Initializes a DocumentManager for the given RestSession.

Method Summary

Modifier and Type	Method	Description
protected abstract @NotNull RestDocumentState<T_REST_DOCUMENT>	accessInternalState(T_REST_DOCUMENT document)	Requests access to the internal RestDocumentState.
T_REST_DOCUMENT	compressDocuments(@NotNull DocumentFileCompress fileCompress)	Compresses a list of RestDocuments selected by documentId or file filter into a new archive document in the document storage.
boolean	containsDocument(@NotNull String documentId)	Returns true, if this DocumentManager contains a RestDocument with the given ID.
protected abstract T_REST_DOCUMENT	createDocument(@NotNull String documentId)	Creates a new RestDocument for the given document ID.
void	deleteDocument(@NotNull String documentId)	Deletes the RestDocument with the given document ID from the webPDF server.
void	downloadDocument(@NotNull String documentId, @NotNull OutputStream outputStream)	Downloads the RestDocument with the given document ID and writes it to the given OutputStream.
void	downloadDocument(@Nullable RestDocument document, @NotNull OutputStream outputStream)	Deprecated.
@NotNull List<T_REST_DOCUMENT>	extractDocument(@NotNull String documentId, @NotNull DocumentFileExtract fileExtract)	Extracts the RestDocument with the given document ID in the document storage.
T_REST_DOCUMENT	getDocument(@NotNull String documentId)	Returns the RestDocument that is known to the DocumentManager for the given document ID.
@NotNull List<HistoryEntry>	getDocumentHistory(@NotNull String documentId)	Returns the HistoryEntrys known for the RestDocument with the given document ID.
@NotNull HistoryEntry	getDocumentHistoryEntry(@NotNull String documentId, int historyId)	Returns the HistoryEntry with the given history ID for the RestDocument with the given document ID.
@NotNull String	getDocumentID(@NotNull DocumentFile document)	Returns the document ID the given DocumentFile is known by to this DocumentManager.
@NotNull DocumentInfo	getDocumentInfo(@NotNull String documentId, @NotNull DocumentInfoType infoType)	Returns information about the document selected by documentId in the document storage.
@NotNull List<T_REST_DOCUMENT>	getDocuments()	Returns a list of all RestDocuments known to this DocumentManager.
@NotNull RestSession<T_REST_DOCUMENT>	getSession()	Returns the RestSession the DocumentManager is managing RestDocuments for.
boolean	isDocumentHistoryActive()	Checks whether a document history is collected for managed RestDocuments.
T_REST_DOCUMENT	renameDocument(@NotNull String documentId, @NotNull String fileName)	Rename the RestDocument with the given document ID.
void	setDocumentHistoryActive(boolean documentHistoryActive)	Sets whether a document history shall be collected for managed RestDocuments.
@NotNull List<T_REST_DOCUMENT>	synchronize()	Synchronizes the RestDocuments of this DocumentManager with the actually uploaded documents of the webPDF server.
@NotNull List<T_REST_DOCUMENT>	synchronize(@NotNull List<DocumentFile> fileList)	Synchronizes the RestDocuments of this DocumentManager with the actually uploaded documents of the webPDF server or with the given fileList.
T_REST_DOCUMENT	synchronizeDocument(@NotNull DocumentFile documentFile)	Synchronizes the given DocumentFile with the matching RestDocument managed by this DocumentManager.
@Nullable HistoryEntry	updateDocumentHistory(@NotNull String documentId, @NotNull HistoryEntry historyEntry)	Updates the history of the RestDocument with the given document ID using the given HistoryEntry.
T_REST_DOCUMENT	updateDocumentSecurity(@NotNull String documentId, @NotNull PdfPasswordType passwordType)	Updates the security information of a selected document in the server´s document storage.
T_REST_DOCUMENT	uploadDocument(@NotNull File file)	Uploads the given File to the webPDF server, adds it to this DocumentManager and returns the resulting RestDocument handle.
T_REST_DOCUMENT	uploadDocument(@NotNull InputStream data, @NotNull String fileName)	Uploads the given InputStream to the webPDF server as a document resource with the given file name, adds it to this DocumentManager and returns the resulting RestDocument handle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDocumentManager

public AbstractDocumentManager(@NotNull
                               @NotNull RestSession<T_REST_DOCUMENT> session)

Initializes a DocumentManager for the given RestSession.

Parameters:

session - The RestSession a DocumentManager shall be created for.

Method Detail

getSession

@NotNull
public @NotNull RestSession<T_REST_DOCUMENT> getSession()

Returns the RestSession the DocumentManager is managing RestDocuments for.

Specified by:

getSession in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Returns:

The RestSession the DocumentManager is managing RestDocuments for.

synchronizeDocument

@NotNull
public T_REST_DOCUMENT synchronizeDocument(@NotNull
                                           @NotNull DocumentFile documentFile)
                                    throws ResultException

Synchronizes the given DocumentFile with the matching RestDocument managed by this DocumentManager.

Specified by:

synchronizeDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Returns:

The synchronized RestDocument.

Throws:

ResultException - Shall be thrown upon a synchronization failure.

synchronize

@NotNull
public @NotNull List<T_REST_DOCUMENT> synchronize(@NotNull
                                                  @NotNull List<DocumentFile> fileList)
                                           throws ResultException

Synchronizes the RestDocuments of this DocumentManager with the actually uploaded documents of the webPDF server or with the given fileList.

Specified by:

synchronize in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

fileList - A DocumentFile list to sync this DocumentManager with

Returns:

A list of the synchronized RestDocuments.

Throws:

ResultException - Shall be thrown upon a synchronization failure.

synchronize

@NotNull
public @NotNull List<T_REST_DOCUMENT> synchronize()
                                           throws ResultException

Synchronizes the RestDocuments of this DocumentManager with the actually uploaded documents of the webPDF server.

Specified by:

synchronize in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Returns:

A list of the synchronized RestDocuments.

Throws:

ResultException - Shall be thrown upon a synchronization failure.

getDocumentID

@NotNull
public @NotNull String getDocumentID(@NotNull
                                     @NotNull DocumentFile document)
                              throws ResultException

Returns the document ID the given DocumentFile is known by to this DocumentManager.

Specified by:

getDocumentID in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

document - The DocumentFile a document ID shall be found for.

Returns:

The document ID mapped to the given DocumentFile.

Throws:

ResultException - Shall be thrown, if requesting the document ID failed.

getDocument

@NotNull
public T_REST_DOCUMENT getDocument(@NotNull
                                   @NotNull String documentId)
                            throws ResultException

Returns the RestDocument that is known to the DocumentManager for the given document ID.

Specified by:

getDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID a RestDocument shall be found for.

Returns:

The RestDocument mapped to the given document ID.

Throws:

ResultException - Shall be thrown, if requesting the document failed.

getDocuments

@NotNull
public @NotNull List<T_REST_DOCUMENT> getDocuments()

Returns a list of all RestDocuments known to this DocumentManager.

Specified by:

getDocuments in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Returns:

A list of all RestDocuments known to this DocumentManager.

containsDocument

public boolean containsDocument(@NotNull
                                @NotNull String documentId)

Returns true, if this DocumentManager contains a RestDocument with the given ID.

Specified by:

containsDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID, that shall be checked for existence.

Returns:

true, if this DocumentManager contains a RestDocument with the given ID.

downloadDocument

public void downloadDocument(@NotNull
                             @NotNull String documentId,
                             @NotNull
                             @NotNull OutputStream outputStream)
                      throws ResultException

Downloads the RestDocument with the given document ID and writes it to the given OutputStream.

Specified by:

downloadDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument to download.

outputStream - The OutputStream to write the downloaded RestDocument to.

Throws:

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

downloadDocument

@Deprecated
public void downloadDocument(@Nullable
                             @Nullable RestDocument document,
                             @NotNull
                             @NotNull OutputStream outputStream)
                      throws ResultException

Deprecated.

Downloads the RestDocument and writes it to the given OutputStream.

Specified by:

downloadDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

document - The RestDocument to download.

outputStream - The OutputStream to write the downloaded RestDocument to.

Throws:

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

uploadDocument

@NotNull
public T_REST_DOCUMENT uploadDocument(@NotNull
                                      @NotNull File file)
                               throws ResultException

Uploads the given File to the webPDF server, adds it to this DocumentManager and returns the resulting RestDocument handle.

Specified by:

uploadDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

file - The File to upload.

Returns:

The resulting RestDocument handle.

Throws:

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

uploadDocument

@NotNull
public T_REST_DOCUMENT uploadDocument(@NotNull
                                      @NotNull InputStream data,
                                      @NotNull
                                      @NotNull String fileName)
                               throws ResultException

Uploads the given InputStream to the webPDF server as a document resource with the given file name, adds it to this DocumentManager and returns the resulting RestDocument handle.

Specified by:

uploadDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

data - The document InputStream to upload.

fileName - The name of the uploaded document.

Returns:

The resulting RestDocument handle.

Throws:

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

deleteDocument

public void deleteDocument(@NotNull
                           @NotNull String documentId)
                    throws ResultException

Deletes the RestDocument with the given document ID from the webPDF server.

Specified by:

deleteDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument to delete.

Throws:

ResultException - Shall be thrown, should deleting the document have failed.

renameDocument

@NotNull
public T_REST_DOCUMENT renameDocument(@NotNull
                                      @NotNull String documentId,
                                      @NotNull
                                      @NotNull String fileName)
                               throws ResultException

Rename the RestDocument with the given document ID.

Specified by:

renameDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument to rename.

fileName - The new name for the RestDocument.

Returns:

The resulting RestDocument handle.

Throws:

ResultException - Shall be thrown, should renaming the document have failed.

isDocumentHistoryActive

public boolean isDocumentHistoryActive()

Checks whether a document history is collected for managed RestDocuments.

Specified by:

isDocumentHistoryActive in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Returns:

true should collecting the document history be active.

setDocumentHistoryActive

public void setDocumentHistoryActive(boolean documentHistoryActive)
                              throws ResultException

Sets whether a document history shall be collected for managed RestDocuments.

Specified by:

setDocumentHistoryActive in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentHistoryActive - true should collecting the document history be activated.

Throws:

ResultException

getDocumentHistory

@NotNull
public @NotNull List<HistoryEntry> getDocumentHistory(@NotNull
                                                      @NotNull String documentId)
                                               throws ResultException

Returns the HistoryEntrys known for the RestDocument with the given document ID.

Specified by:

getDocumentHistory in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument the history shall be requested for.

Returns:

The HistoryEntrys known for the selected RestDocument.

Throws:

ResultException - Shall be thrown, should requesting the document history have failed.

getDocumentHistoryEntry

@NotNull
public @NotNull HistoryEntry getDocumentHistoryEntry(@NotNull
                                                     @NotNull String documentId,
                                                     int historyId)
                                              throws ResultException

Returns the HistoryEntry with the given history ID for the RestDocument with the given document ID.

Specified by:

getDocumentHistoryEntry in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument the HistoryEntry shall be requested for.

historyId - The history ID of the HistoryEntry, that shall be requested.

Returns:

The selected HistoryEntry.

Throws:

ResultException - Shall be thrown, should requesting the document history have failed.

updateDocumentHistory

@Nullable
public @Nullable HistoryEntry updateDocumentHistory(@NotNull
                                                    @NotNull String documentId,
                                                    @NotNull
                                                    @NotNull HistoryEntry historyEntry)
                                             throws ResultException

Updates the history of the RestDocument with the given document ID using the given HistoryEntry.

Specified by:

updateDocumentHistory in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument to update.

historyEntry - The HistoryEntry to update the contained values for.

Returns:

The updated HistoryEntry.

Throws:

ResultException - Shall be thrown, should updating the document history have failed.

createDocument

@NotNull
protected abstract T_REST_DOCUMENT createDocument(@NotNull
                                                  @NotNull String documentId)
                                           throws ResultException

Creates a new RestDocument for the given document ID.

Parameters:

documentId - The document ID a matching RestDocument shall be created for.

Returns:

The created RestDocument.

Throws:

ResultException - Shall be thrown, should creating the document fail.

updateDocumentSecurity

@NotNull
public T_REST_DOCUMENT updateDocumentSecurity(@NotNull
                                              @NotNull String documentId,
                                              @NotNull
                                              @NotNull PdfPasswordType passwordType)
                                       throws ResultException

Updates the security information of a selected document in the server´s document storage.

Specified by:

updateDocumentSecurity in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The unique documentId of the document in the server´s document storage.

passwordType - The security information to update the document with

Returns:

The updated RestDocument.

Throws:

ResultException - Shall be thrown, should updating the document security have failed.

accessInternalState

@NotNull
protected abstract @NotNull RestDocumentState<T_REST_DOCUMENT> accessInternalState(@NotNull
                                                                                   T_REST_DOCUMENT document)

Requests access to the internal RestDocumentState.

Parameters:

document - The RestDocument to request access for.

Returns:

The internal RestDocumentState.

getDocumentInfo

@NotNull
public @NotNull DocumentInfo getDocumentInfo(@NotNull
                                             @NotNull String documentId,
                                             @NotNull
                                             @NotNull DocumentInfoType infoType)
                                      throws ResultException

Returns information about the document selected by documentId in the document storage.

Specified by:

getDocumentInfo in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The unique documentId of the document in the server´s document storage.

infoType - Detailed information for the document referenced by the unique documentId in the server´s document storage.

Returns:

The requested document DocumentInfo

Throws:

ResultException - Shall be thrown, should fetching the document info has failed.

extractDocument

@NotNull
public @NotNull List<T_REST_DOCUMENT> extractDocument(@NotNull
                                                      @NotNull String documentId,
                                                      @NotNull
                                                      @NotNull DocumentFileExtract fileExtract)
                                               throws ResultException

Extracts the RestDocument with the given document ID in the document storage.

• The document referenced by documentId must be a valid archive. If not, the operation will be aborted.
• For each file in the archive, a new DocumentFile is created in the document storage with a new documentId.
• Each newly created DocumentFile holds as parentDocumentId the documentId of the archive.

Specified by:

extractDocument in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

documentId - The document ID of the RestDocument to extract.

fileExtract - DocumentFileExtract settings for unpacking the archive document.

Returns:

A list of the extracted RestDocuments.

Throws:

ResultException - Shall be thrown, should the extraction has failed.

compressDocuments

@NotNull
public T_REST_DOCUMENT compressDocuments(@NotNull
                                         @NotNull DocumentFileCompress fileCompress)
                                  throws ResultException

Compresses a list of RestDocuments selected by documentId or file filter into a new archive document in the document storage.

• The list of documents that should be in the archive are selected via the documentId or a file filter.
• The selection specifications can be made individually or together and act additively in the order documentId and then file filter.
• If the id is invalid for documents selected via documentId or documents are locked, then the call is aborted with an error.
• The created archive is stored as a new document with a new documentId in the document storage.

Specified by:

compressDocuments in interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Parameters:

fileCompress - The DocumentFileCompress settings for creating the archive document and for selecting and filtering the documents to be added to the archive.

Returns:

The compressed RestDocument.

Throws:

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