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

Class RestWebServiceDocument

java.lang.Object

net.webpdf.wsclient.session.documents.AbstractDocument

net.webpdf.wsclient.session.rest.documents.RestWebServiceDocument

All Implemented Interfaces:

Document, RestDocument

public class RestWebServiceDocument
extends AbstractDocument
implements RestDocument

An instance of RestWebServiceDocument represents a document, that has been uploaded to a webPDF server.

Method Summary

Modifier and Type	Method	Description
void	deleteDocument()	This is a shortcut for DocumentManager.deleteDocument(java.lang.String) and deletes the RestDocument.
void	downloadDocument(@NotNull File target)	This is a shortcut for DocumentManager.downloadDocument(String, OutputStream) and Attempts to download write the RestDocument to the given File.
void	downloadDocument(@NotNull OutputStream target)	This is a shortcut for DocumentManager.downloadDocument(String, OutputStream) and Attempts to download and write the RestDocument to the given OutputStream.
List<RestWebServiceDocument>	extractDocument(@NotNull DocumentFileExtract fileExtract)	This is a shortcut for DocumentManager.extractDocument(java.lang.String, net.webpdf.wsclient.openapi.DocumentFileExtract) and extracts the RestDocument.
@NotNull DocumentFile	getDocumentFile()	Returns the DocumentFile of the managed RestDocument.
@NotNull String	getDocumentId()	Returns the document ID of the managed RestDocument.
DocumentInfo	getDocumentInfo(@NotNull DocumentInfoType infoType)	This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and returns DocumentInfo about the RestDocument.
@NotNull List<HistoryEntry>	getHistory()	Returns the HistoryEntrys of the managed RestDocument.
@NotNull HistoryEntry	getHistoryEntry(int historyId)	Returns a HistoryEntry from the internal history map, by given history ID.
@NotNull RestDocument	renameDocument(@NotNull String fileName)	This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and renames the RestDocument.
RestDocument	updateDocumentSecurity(@NotNull PdfPasswordType passwordType)	This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and updates the security information the RestDocument.

Methods inherited from class net.webpdf.wsclient.session.documents.AbstractDocument

getSource, isFileSource

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

getSource, isFileSource

Method Detail

getDocumentId

@NotNull
public @NotNull String getDocumentId()

Returns the document ID of the managed RestDocument.

Specified by:

getDocumentId in interface RestDocument

Returns:

The document ID of the managed RestDocument.

getDocumentFile

@NotNull
public @NotNull DocumentFile getDocumentFile()

Returns the DocumentFile of the managed RestDocument.

Specified by:

getDocumentFile in interface RestDocument

Returns:

The DocumentFile of the managed RestDocument.

getHistory

@NotNull
public @NotNull List<HistoryEntry> getHistory()

Returns the HistoryEntrys of the managed RestDocument.

Specified by:

getHistory in interface RestDocument

Returns:

The HistoryEntrys of the managed RestDocument.

getHistoryEntry

@NotNull
public @NotNull HistoryEntry getHistoryEntry(int historyId)
                                      throws ResultException

Returns a HistoryEntry from the internal history map, by given history ID.

Specified by:

getHistoryEntry in interface RestDocument

Parameters:

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

Returns:

A HistoryEntry representing a historic state of the uploaded resource.

Throws:

ResultException - Shall be thrown, should accessing the document history fail.

downloadDocument

public void downloadDocument(@NotNull
                             @NotNull OutputStream target)
                      throws ResultException

This is a shortcut for DocumentManager.downloadDocument(String, OutputStream) and Attempts to download and write the RestDocument to the given OutputStream.

Specified by:

downloadDocument in interface RestDocument

Parameters:

target - The target OutputStream the RestDocument shall be written to.

Throws:

ResultException - Shall be thrown, should writing the result document fail.

downloadDocument

public void downloadDocument(@NotNull
                             @NotNull File target)
                      throws ResultException

This is a shortcut for DocumentManager.downloadDocument(String, OutputStream) and Attempts to download write the RestDocument to the given File.

Specified by:

downloadDocument in interface RestDocument

Parameters:

target - The target File the RestDocument shall be written to.

Throws:

ResultException - Shall be thrown, should writing the result document fail.

deleteDocument

public void deleteDocument()
                    throws ResultException

This is a shortcut for DocumentManager.deleteDocument(java.lang.String) and deletes the RestDocument.

Specified by:

deleteDocument in interface RestDocument

Throws:

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

renameDocument

@NotNull
public @NotNull RestDocument renameDocument(@NotNull
                                            @NotNull String fileName)
                                     throws ResultException

This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and renames the RestDocument.

Specified by:

renameDocument in interface RestDocument

Parameters:

fileName - The new name for the RestDocument.

Returns:

The resulting RestDocument handle.

Throws:

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

updateDocumentSecurity

public RestDocument updateDocumentSecurity(@NotNull
                                           @NotNull PdfPasswordType passwordType)
                                    throws ResultException

This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and updates the security information the RestDocument.

Specified by:

updateDocumentSecurity in interface RestDocument

Parameters:

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

public DocumentInfo getDocumentInfo(@NotNull
                                    @NotNull DocumentInfoType infoType)
                             throws ResultException

This is a shortcut for DocumentManager.renameDocument(java.lang.String, java.lang.String) and returns DocumentInfo about the RestDocument.

Specified by:

getDocumentInfo in interface RestDocument

Parameters:

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

public List<RestWebServiceDocument> extractDocument(@NotNull
                                                    @NotNull DocumentFileExtract fileExtract)
                                             throws ResultException

This is a shortcut for DocumentManager.extractDocument(java.lang.String, net.webpdf.wsclient.openapi.DocumentFileExtract) and extracts the RestDocument.

Specified by:

extractDocument in interface RestDocument

Parameters:

fileExtract - DocumentFileExtract settings for unpacking the archive document.

Returns:

A list of the extracted RestDocuments.

Throws:

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