com.laserfiche.repository.api.clients.impl

Class TasksClientImpl

java.lang.Object

com.laserfiche.repository.api.clients.impl.ApiClient

com.laserfiche.repository.api.clients.impl.TasksClientImpl

All Implemented Interfaces:

TasksClient

public class TasksClientImpl
extends ApiClient
implements TasksClient

Field Summary

Fields inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

baseUrl, httpClient, objectMapper

Constructor Summary

Constructors

Constructor and Description
TasksClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient)

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.

Methods inherited from class com.laserfiche.repository.api.clients.impl.ApiClient

decideErrorMessage, deserializeToProblemDetails, getHeadersMap, getNonNullParameters, mergeMaxSizeIntoPrefer, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksClientImpl

public TasksClientImpl(String baseUrl,
                       kong.unirest.UnirestInstance httpClient)

Method Detail

getOperationStatusAndProgress

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

Description copied from interface: TasksClient

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

Specified by:

getOperationStatusAndProgress in interface TasksClient

Parameters:

repoId - The requested repository ID

operationToken - The operation token

Returns:

CompletableFuture<OperationProgress> The return value

cancelOperation

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

Description copied from interface: TasksClient

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

Specified by:

cancelOperation in interface TasksClient

Parameters:

repoId - The requested repository ID

operationToken - The operation token

Returns:

CompletableFuture<Boolean> The return value