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

The Laserfiche Repository Tasks API client.

Field Summary

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

baseUrl, httpClient, httpRequestHandler, objectMapper

Constructor Summary

Constructors

Constructor and Description
TasksClientImpl(String baseUrl, kong.unirest.UnirestInstance httpClient, com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Summary

Modifier and Type	Method and Description
boolean	cancelOperation(ParametersForCancelOperation parameters) - Cancels an operation. - Provide an operationToken to cancel the operation, if possible.
OperationProgress	getOperationStatusAndProgress(ParametersForGetOperationStatusAndProgress parameters) - 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.

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

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,
                       com.laserfiche.api.client.httphandlers.HttpRequestHandler httpRequestHandler)

Method Detail

getOperationStatusAndProgress

public OperationProgress getOperationStatusAndProgress(ParametersForGetOperationStatusAndProgress parameters)

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:

parameters - An object of type ParametersForGetOperationStatusAndProgress which encapsulates the parameters of getOperationStatusAndProgress method.

Returns:

OperationProgress The return value

cancelOperation

public boolean cancelOperation(ParametersForCancelOperation parameters)

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:

parameters - An object of type ParametersForCancelOperation which encapsulates the parameters of cancelOperation method.

Returns:

boolean The return value