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

Class RestWebServiceDocumentManager

java.lang.Object

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

net.webpdf.wsclient.session.rest.documents.RestWebServiceDocumentManager

All Implemented Interfaces:

DocumentManager<RestWebServiceDocument>

public class RestWebServiceDocumentManager
extends AbstractDocumentManager<RestWebServiceDocument>

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

Constructor Summary

Constructors

Constructor	Description
RestWebServiceDocumentManager(@NotNull RestSession<RestWebServiceDocument> session)	Initializes a RestWebServiceDocumentManager for the given RestSession.

Method Summary

Modifier and Type	Method	Description
protected @NotNull RestWebServiceDocumentState	accessInternalState(@NotNull RestWebServiceDocument document)	Requests access to the internal RestDocumentState.
protected @NotNull RestWebServiceDocument	createDocument(@NotNull String documentId)	Creates a new RestWebServiceDocument for the given document ID.

Methods inherited from class net.webpdf.wsclient.session.rest.documents.AbstractDocumentManager

compressDocuments, containsDocument, deleteDocument, downloadDocument, downloadDocument, extractDocument, getDocument, getDocumentHistory, getDocumentHistoryEntry, getDocumentID, getDocumentInfo, getDocuments, getSession, isDocumentHistoryActive, renameDocument, setDocumentHistoryActive, synchronize, synchronize, synchronizeDocument, updateDocumentHistory, updateDocumentSecurity, uploadDocument, uploadDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

RestWebServiceDocumentManager

public RestWebServiceDocumentManager(@NotNull
                                     @NotNull RestSession<RestWebServiceDocument> session)

Initializes a RestWebServiceDocumentManager for the given RestSession.

Parameters:

session - The RestSession a RestWebServiceDocumentManager shall be created for.

Method Detail

createDocument

@NotNull
protected @NotNull RestWebServiceDocument createDocument(@NotNull
                                                         @NotNull String documentId)

Creates a new RestWebServiceDocument for the given document ID.

Specified by:

createDocument in class AbstractDocumentManager<RestWebServiceDocument>

Parameters:

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

Returns:

The created RestWebServiceDocument.

accessInternalState

@NotNull
protected @NotNull RestWebServiceDocumentState accessInternalState(@NotNull
                                                                   @NotNull RestWebServiceDocument document)

Requests access to the internal RestDocumentState.

Specified by:

accessInternalState in class AbstractDocumentManager<RestWebServiceDocument>

Parameters:

document - The RestDocument to request access for.

Returns:

The internal RestDocumentState.