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

Interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

Type Parameters:

T_REST_DOCUMENT - The RestDocument type managed by the DocumentManager.

All Known Implementing Classes:

AbstractDocumentManager, RestWebServiceDocumentManager

public interface DocumentManager<T_REST_DOCUMENT extends RestDocument>

A class implementing DocumentManager allows to monitor and interact with the RestDocuments uploaded to a RestSession of the webPDF server.

Method Summary

Modifier and Type	Method	Description
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.
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.

Method Detail

getSession

@NotNull
@NotNull RestSession<T_REST_DOCUMENT> getSession()

Returns the RestSession the DocumentManager is managing RestDocuments for.

Returns:

The RestSession the DocumentManager is managing RestDocuments for.

synchronizeDocument

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

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

Returns:

The synchronized RestDocument.

Throws:

ResultException - Shall be thrown upon a synchronization failure.

synchronize

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

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
@NotNull List<T_REST_DOCUMENT> synchronize()
                                    throws ResultException

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

Returns:

A list of the synchronized RestDocuments.

Throws:

ResultException - Shall be thrown upon a synchronization failure.

getDocumentID

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

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

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
T_REST_DOCUMENT getDocument(@NotNull
                            @NotNull String documentId)
                     throws ResultException

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

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
@NotNull List<T_REST_DOCUMENT> getDocuments()

Returns a list of all RestDocuments known to this DocumentManager.

Returns:

A list of all RestDocuments known to this DocumentManager.

containsDocument

boolean containsDocument(@NotNull
                         @NotNull String documentId)

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

Parameters:

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

Returns:

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

downloadDocument

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.

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
void downloadDocument(@Nullable
                      @Nullable RestDocument document,
                      @NotNull
                      @NotNull OutputStream outputStream)
               throws ResultException

Deprecated.

Downloads the RestDocument and writes it to the given OutputStream.

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

Parameters:

file - The File to upload.

Returns:

The resulting RestDocument handle.

Throws:

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

uploadDocument

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

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

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

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

Parameters:

documentId - The document ID of the RestDocument to delete.

Throws:

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

renameDocument

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

Rename the RestDocument with the given document ID.

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

boolean isDocumentHistoryActive()

Checks whether a document history is collected for managed RestDocuments.

Returns:

true should collecting the document history be active.

setDocumentHistoryActive

void setDocumentHistoryActive(boolean documentHistoryActive)
                       throws ResultException

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

Parameters:

documentHistoryActive - true should collecting the document history be activated.

Throws:

ResultException

getDocumentHistory

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

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

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

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

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.

updateDocumentSecurity

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

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.

getDocumentInfo

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

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 have failed.

extractDocument

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

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

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.