Module evita.java.driver

Package io.evitadb.driver

Class EvitaClientManagement

java.lang.Object

io.evitadb.driver.EvitaClientManagement

All Implemented Interfaces:

EvitaManagementContract, Closeable, AutoCloseable

public class EvitaClientManagement
extends Object
implements EvitaManagementContract, Closeable

Client implementation of EvitaManagementContract.

Author:

Jan Novotný (novotny@fg.cz), FG Forrest a.s. (c) 2024

Constructor Summary

Constructors

Constructor	Description
EvitaClientManagement(EvitaClient evitaClient, com.linecorp.armeria.client.grpc.GrpcClientBuilder grpcClientBuilder)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<FileForFetch>	backupCatalog(String catalogName, OffsetDateTime pastMoment, boolean includingWAL)
boolean	cancelTask(UUID jobId)
void	close()
<S, T> ClientTask<S,T>	createTask(TaskStatus<S,T> taskStatus)	Creates a new client task.
void	deleteFile(UUID fileId)
InputStream	fetchFile(UUID fileId)
CatalogStatistics[]	getCatalogStatistics()
String	getConfiguration()
Optional<FileForFetch>	getFileToFetch(UUID fileId)
SystemStatus	getSystemStatus()
Optional<TaskStatus<?,?>>	getTaskStatus(UUID jobId)
Collection<TaskStatus<?,?>>	getTaskStatuses(UUID... jobId)
io.evitadb.dataType.PaginatedList<FileForFetch>	listFilesToFetch(int page, int pageSize, String origin)
io.evitadb.dataType.PaginatedList<TaskStatus<?,?>>	listTaskStatuses(int page, int pageSize, String[] taskType, TaskStatus.TaskSimplifiedState... states)
Task<?,Void>	restoreCatalog(String catalogName, long totalBytesExpected, InputStream inputStream)
Task<?,Void>	restoreCatalog(String catalogName, UUID fileId)

Methods inherited from class java.lang.Object

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

Constructor Details

EvitaClientManagement

public EvitaClientManagement(@Nonnull
 EvitaClient evitaClient,
 @Nonnull
 com.linecorp.armeria.client.grpc.GrpcClientBuilder grpcClientBuilder)

Method Details

getCatalogStatistics

@Nonnull
public CatalogStatistics[] getCatalogStatistics()

Specified by:

getCatalogStatistics in interface EvitaManagementContract

backupCatalog

@Nonnull
public CompletableFuture<FileForFetch> backupCatalog(@Nonnull
 String catalogName,
 @Nullable
 OffsetDateTime pastMoment,
 boolean includingWAL)
                                              throws TemporalDataNotAvailableException

Specified by:

backupCatalog in interface EvitaManagementContract

Throws:

TemporalDataNotAvailableException

restoreCatalog

@Nonnull
public Task<?,Void> restoreCatalog(@Nonnull
 String catalogName,
 long totalBytesExpected,
 @Nonnull
 InputStream inputStream)
                            throws io.evitadb.exception.UnexpectedIOException

Specified by:

restoreCatalog in interface EvitaManagementContract

Throws:

io.evitadb.exception.UnexpectedIOException

restoreCatalog

@Nonnull
public Task<?,Void> restoreCatalog(@Nonnull
 String catalogName,
 @Nonnull
 UUID fileId)
                            throws FileForFetchNotFoundException

Specified by:

restoreCatalog in interface EvitaManagementContract

Throws:

FileForFetchNotFoundException

listTaskStatuses

@Nonnull
public io.evitadb.dataType.PaginatedList<TaskStatus<?,?>> listTaskStatuses(int page,
 int pageSize,
 @Nullable
 String[] taskType,
 @Nonnull
 TaskStatus.TaskSimplifiedState... states)

Specified by:

listTaskStatuses in interface EvitaManagementContract

getTaskStatus

@Nonnull
public Optional<TaskStatus<?,?>> getTaskStatus(@Nonnull
 UUID jobId)

Specified by:

getTaskStatus in interface EvitaManagementContract

getTaskStatuses

@Nonnull
public Collection<TaskStatus<?,?>> getTaskStatuses(@Nonnull
 UUID... jobId)

Specified by:

getTaskStatuses in interface EvitaManagementContract

cancelTask

public boolean cancelTask(@Nonnull
 UUID jobId)

Specified by:

cancelTask in interface EvitaManagementContract

listFilesToFetch

@Nonnull
public io.evitadb.dataType.PaginatedList<FileForFetch> listFilesToFetch(int page,
 int pageSize,
 @Nullable
 String origin)

Specified by:

listFilesToFetch in interface EvitaManagementContract

getFileToFetch

@Nonnull
public Optional<FileForFetch> getFileToFetch(@Nonnull
 UUID fileId)

Specified by:

getFileToFetch in interface EvitaManagementContract

fetchFile

@Nonnull
public InputStream fetchFile(@Nonnull
 UUID fileId)
                      throws FileForFetchNotFoundException,
io.evitadb.exception.UnexpectedIOException

Specified by:

fetchFile in interface EvitaManagementContract

Throws:

FileForFetchNotFoundException

io.evitadb.exception.UnexpectedIOException

deleteFile

public void deleteFile(@Nonnull
 UUID fileId)
                throws FileForFetchNotFoundException

Specified by:

deleteFile in interface EvitaManagementContract

Throws:

FileForFetchNotFoundException

getSystemStatus

@Nonnull
public SystemStatus getSystemStatus()

Specified by:

getSystemStatus in interface EvitaManagementContract

getConfiguration

@Nonnull
public String getConfiguration()

Specified by:

getConfiguration in interface EvitaManagementContract

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

createTask

@Nonnull
public <S,
T> ClientTask<S,T> createTask(@Nonnull
 TaskStatus<S,T> taskStatus)

Creates a new client task. If the task is not yet completed (finished or failed), it is added to the queue of tracked tasks and its status is updated in the background, so that the Task.getFutureResult() is completed when the task is finished.

Type Parameters:

S - the type of the settings of the task

T - the type of the result of the task

Parameters:

taskStatus - the status of the task to be tracked

Returns:

the client task that is tracking the status of the task