net.webpdf.wsclient.documents

Class DocumentManager

java.lang.Object

net.webpdf.wsclient.documents.DocumentManager

public class DocumentManager
extends Object

Document manager - session bounded

Constructor Summary

Constructors

Constructor and Description
DocumentManager(@NotNull RestSession session) Initializes a document manager for the given RestSession.

Method Summary

Modifier and Type	Method and Description
RestDocument	activateHistory(@NotNull String documentId, int historyId) Activates a history entry for the RestDocument
void	deleteDocument(@NotNull String documentId) Deletes the given RestDocument from the webPDF server by given documentId.
void	downloadDocument(@Nullable RestDocument document, @Nullable OutputStream outputStream) Deprecated.
void	downloadDocument(@NotNull String documentId, @Nullable OutputStream outputStream) Downloads RestDocument referenced by document id from server and stores the content in the OutputStream
@NotNull RestDocument	findDocument(@NotNull String documentId) Returns the RestDocument from the internal document map, by given documentId.
@NotNull RestDocument	getDocument(@Nullable DocumentFileBean documentFileBean) Deprecated.
@NotNull List<RestDocument>	getDocuments() Gets a copy of all List<RestDocument> from the internal document map.
boolean	hasDocument(@NotNull String documentId) Checks, if a RestDocument with a given id exists in the list of documents
boolean	isUseHistory() checks if the creation of a document history is active
@NotNull RestDocument	renameDocument(@NotNull String documentId, @Nullable String fileName) Renames the RestDocument on the webPDF server, by given documentId, to the given filename.
void	setUseHistory(boolean useHistory) De/Activates the creation of a document history
void	sync() Syncs the list of RestDocument with the server.
void	updateHistoryForDocument(@NotNull String documentId) Updates the history entries for the RestDocument referenced by the document id
RestDocument	updateHistoryOperation(@NotNull String documentId, int historyId, @NotNull String operation) Updates the operation value for a history entry in a RestDocument
@NotNull RestDocument	uploadDocument(@Nullable File file) Uploads the given File to the server and returns the RestDocument reference to the uploaded resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentManager

public DocumentManager(@NotNull
                       @NotNull RestSession session)

Initializes a document manager for the given RestSession.

Parameters:

session - The RestSession a document manager shall be created for.

Method Detail

downloadDocument

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

Deprecated.

Downloads SoapDocument or RestDocument to target path

Parameters:

document - SoapDocument or RestDocument instance

outputStream - OutputStream for downloaded content

Throws:

ResultException - a ResultException

downloadDocument

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

Downloads RestDocument referenced by document id from server and stores the content in the OutputStream

Parameters:

documentId - The document id of the RestDocument

outputStream - OutputStream for downloaded content

Throws:

ResultException - a ResultException

uploadDocument

@NotNull
public @NotNull RestDocument uploadDocument(@Nullable
                                                      @Nullable File file)
                                               throws IOException

Uploads the given File to the server and returns the RestDocument reference to the uploaded resource.

Parameters:

file - The file, that shall be uploaded for further processing.

Returns:

a RestDocument referencing the uploaded document.

Throws:

IOException - an IOException

findDocument

@NotNull
public @NotNull RestDocument findDocument(@NotNull
                                                    @NotNull String documentId)
                                             throws ResultException

Returns the RestDocument from the internal document map, by given documentId.

Parameters:

documentId - The document id of the RestDocument that shall be returned.

Returns:

A RestDocument referencing the uploaded resource.

Throws:

ResultException - if RestDocument wasn't found in the internal document map

hasDocument

public boolean hasDocument(@NotNull
                           @NotNull String documentId)

Checks, if a RestDocument with a given id exists in the list of documents

Parameters:

documentId - id to search in the list of RestDocument

Returns:

documentId true, if the document exists

getDocument

@NotNull
 @Deprecated
public @NotNull RestDocument getDocument(@Nullable
                                                                 @Nullable DocumentFileBean documentFileBean)
                                                          throws ResultException

Deprecated.

returns the RestDocument from the internal document map, by given DocumentFileBean or if the Document doesn't exist create a new entry from the given DocumentFileBean

Parameters:

documentFileBean - The DocumentFileBean, that shall be returned or added for further processing.

Returns:

A RestDocument referencing the uploaded resource.

Throws:

ResultException - a ResultException

deleteDocument

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

Deletes the given RestDocument from the webPDF server by given documentId.

Parameters:

documentId - The document id of the RestDocument that shall be deleted.

Throws:

ResultException - If document does not exist

renameDocument

@NotNull
public @NotNull RestDocument renameDocument(@NotNull
                                                      @NotNull String documentId,
                                                      @Nullable
                                                      @Nullable String fileName)
                                               throws IOException

Renames the RestDocument on the webPDF server, by given documentId, to the given filename.

Parameters:

documentId - The document id of the RestDocument that shall be renamed.

fileName - The new file name

Returns:

A RestDocument referencing the renamed resource.

Throws:

ResultException - a ResultException

IOException

updateHistoryForDocument

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

Updates the history entries for the RestDocument referenced by the document id

Parameters:

documentId - The document id of the RestDocument

Throws:

ResultException - When a document with the given document id does not exist

activateHistory

public RestDocument activateHistory(@NotNull
                                    @NotNull String documentId,
                                    int historyId)
                             throws ResultException

Activates a history entry for the RestDocument

Parameters:

documentId - unique document id

historyId - unique history id to activate

Returns:

document for which the active history was changed

Throws:

ResultException - unable to change history

updateHistoryOperation

public RestDocument updateHistoryOperation(@NotNull
                                           @NotNull String documentId,
                                           int historyId,
                                           @NotNull
                                           @NotNull String operation)
                                    throws ResultException

Updates the operation value for a history entry in a RestDocument

Parameters:

documentId - unique document id

historyId - unique history id to activate

Returns:

operation new operation text

Throws:

ResultException - unable to change history

sync

public void sync()
          throws ResultException

Syncs the list of RestDocument with the server. Clears the internal lists and loads all RestDocument again from the sever. This is e.g. used, when calling a login on RestSession with an existing Token

Throws:

ResultException - a ResultException

getDocuments

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

Gets a copy of all List<RestDocument> from the internal document map.

Returns:

a List referencing the RestDocuments.

isUseHistory

public boolean isUseHistory()

checks if the creation of a document history is active

Returns:

is the document history active?

setUseHistory

public void setUseHistory(boolean useHistory)

De/Activates the creation of a document history

Parameters:

useHistory - De/Activates the creation of a document history