Package com.intellectualsites.arkitektonika.v1

Class ApiClient

java.lang.Object

com.intellectualsites.arkitektonika.v1.ApiClient

All Implemented Interfaces:

ApiClient

public final class ApiClient
extends Object
implements ApiClient

Constructor Summary

Constructors

Constructor	Description
ApiClient(@NotNull String url)

Method Summary

Modifier and Type	Method	Description
@NotNull CompletableFuture<Boolean>	checkCompatibility(@NotNull ExecutorService service)	Check if the specified API address is compatible with the client
@NotNull CompletableFuture<ResourceStatus>	checkStatus(@NotNull String key, @NotNull ExecutorService service)	Check the status of a remote schematic
@NotNull CompletableFuture<Boolean>	delete(@NotNull String key, @NotNull ExecutorService service)	Attempt to delete a schematic from the remote service
@NotNull CompletableFuture<Schematic>	download(@NotNull String key, @NotNull ExecutorService service)	Attempt to download a schematic from the remote service
@NotNull ApiVersion	getApiVersion()	Get the API version supported by this client
@NotNull CompletableFuture<SchematicKeys>	upload(@NotNull File file, @NotNull ExecutorService service)	Upload a schematic via an input stream

Methods inherited from class java.lang.Object

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

Constructor Details

ApiClient

public ApiClient(@NotNull
 @NotNull String url)

Method Details

getApiVersion

@NotNull
public @NotNull ApiVersion getApiVersion()

Description copied from interface: ApiClient

Get the API version supported by this client

Specified by:

getApiVersion in interface ApiClient

Returns:

API version

checkCompatibility

@NotNull
public @NotNull CompletableFuture<Boolean> checkCompatibility(@NotNull
 @NotNull ExecutorService service)

Description copied from interface: ApiClient

Check if the specified API address is compatible with the client

Specified by:

checkCompatibility in interface ApiClient

Parameters:

service - Executor service used to complete the request

Returns:

Future that completes with the result of the query

upload

@NotNull
public @NotNull CompletableFuture<SchematicKeys> upload(@NotNull
 @NotNull File file,
 @NotNull
 @NotNull ExecutorService service)

Description copied from interface: ApiClient

Upload a schematic via an input stream

Specified by:

upload in interface ApiClient

Parameters:

file - File to upload

service - Executor service used to complete the request

Returns:

Future that completes with the access and deletion keys of the uploaded resource, or fails with an exception

checkStatus

@NotNull
public @NotNull CompletableFuture<ResourceStatus> checkStatus(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull ExecutorService service)

Description copied from interface: ApiClient

Check the status of a remote schematic

Specified by:

checkStatus in interface ApiClient

Parameters:

key - Schematic access key

service - Executor service used to complete the request

Returns:

Future that completes with the resource status

delete

@NotNull
public @NotNull CompletableFuture<Boolean> delete(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull ExecutorService service)

Description copied from interface: ApiClient

Attempt to delete a schematic from the remote service

Specified by:

delete in interface ApiClient

Parameters:

key - Deletion key

service - Executor service used to complete the request

Returns:

Future that completes with the result

download

@NotNull
public @NotNull CompletableFuture<Schematic> download(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull ExecutorService service)

Description copied from interface: ApiClient

Attempt to download a schematic from the remote service

Specified by:

download in interface ApiClient

Parameters:

key - Download key

service - Executor service used to complete the request

Returns:

Future that completes with the result