Package io.camunda.document.api

Interface DocumentStore

public interface DocumentStore

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SETUP_VALIDATION_FAILURE_MESSAGE

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Either<DocumentError,DocumentReference>>	createDocument(DocumentCreationRequest request)
CompletableFuture<Either<DocumentError,DocumentLink>>	createLink(String documentId, long durationInMillis)
CompletableFuture<Either<DocumentError,Void>>	deleteDocument(String documentId)
CompletableFuture<Either<DocumentError,DocumentContent>>	getDocument(String documentId)
default void	validateSetup()
CompletableFuture<Either<DocumentError,Void>>	verifyContentHash(String documentId, String contentHash)

Field Details

SETUP_VALIDATION_FAILURE_MESSAGE

static final String SETUP_VALIDATION_FAILURE_MESSAGE

See Also:

• Constant Field Values

Method Details

createDocument

CompletableFuture<Either<DocumentError,DocumentReference>> createDocument(DocumentCreationRequest request)

getDocument

CompletableFuture<Either<DocumentError,DocumentContent>> getDocument(String documentId)

deleteDocument

CompletableFuture<Either<DocumentError,Void>> deleteDocument(String documentId)

createLink

CompletableFuture<Either<DocumentError,DocumentLink>> createLink(String documentId,
 long durationInMillis)

verifyContentHash

CompletableFuture<Either<DocumentError,Void>> verifyContentHash(String documentId,
 String contentHash)

validateSetup

default void validateSetup()