com.laserfiche.repository.api.clients

Interface TasksClient

All Known Implementing Classes:

TasksClientImpl

public interface TasksClient

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	cancelOperation(String repoId, String operationToken) - Cancels an operation.
CompletableFuture<OperationProgress>	getOperationStatusAndProgress(String repoId, String operationToken) - Returns the status of an operation.

Method Detail

getOperationStatusAndProgress

CompletableFuture<OperationProgress> getOperationStatusAndProgress(String repoId,
                                                                   String operationToken)

- Returns the status of an operation. - Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant). - OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed.

Parameters:

repoId - The requested repository ID

operationToken - The operation token

Returns:

CompletableFuture<OperationProgress> The return value

cancelOperation

CompletableFuture<Boolean> cancelOperation(String repoId,
                                           String operationToken)

- Cancels an operation. - Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary. - Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.

Parameters:

repoId - The requested repository ID

operationToken - The operation token

Returns:

CompletableFuture<Boolean> The return value