Package org.infinispan.client.rest

Interface RestClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

RestClientOkHttp

@Experimental("This is not a supported API. Are you here for a perilous journey?")
public interface RestClient
extends Closeable

An experimental client for interacting with an Infinispan REST server.

Since:

10.0

Author:

Tristan Tarrant <tristan@infinispan.org>

Method Summary

Modifier and Type	Method	Description
RestCacheClient	cache(String name)	Operations on the specified cache
RestCacheManagerClient	cacheManager(String name)	Operations on the specified cache manager
CompletionStage<RestResponse>	cacheManagers()	Returns a list of available cache manager names
CompletionStage<RestResponse>	caches()	Returns a list of available caches
void	close()
RestClusterClient	cluster()	Interact with the whole cluster
RestContainerClient	container()	Operations on the server's Container
RestCounterClient	counter(String name)	Operations on the specified counter
CompletionStage<RestResponse>	counters()	Returns a list of available counters
static RestClient	forConfiguration(RestClientConfiguration configuration)	Creates a RestClient instance based on the supplied configuration
RestClientConfiguration	getConfiguration()	Returns the configuration of this RestClient
RestMetricsClient	metrics()	Server metrics
RestRawClient	raw()	Raw HTTP operations
RestSchemaClient	schemas()	Protobuf schemas
RestSecurityClient	security()	Server security
RestServerClient	server()	Interact with the single server
RestTaskClient	tasks()	Operations on tasks

Method Details

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

server

RestServerClient server()

Interact with the single server

cluster

RestClusterClient cluster()

Interact with the whole cluster

cacheManagers

CompletionStage<RestResponse> cacheManagers()

Returns a list of available cache manager names

cacheManager

RestCacheManagerClient cacheManager(String name)

Operations on the specified cache manager

container

RestContainerClient container()

Operations on the server's Container

caches

CompletionStage<RestResponse> caches()

Returns a list of available caches

cache

RestCacheClient cache(String name)

Operations on the specified cache

counters

CompletionStage<RestResponse> counters()

Returns a list of available counters

counter

RestCounterClient counter(String name)

Operations on the specified counter

tasks

RestTaskClient tasks()

Operations on tasks

raw

RestRawClient raw()

Raw HTTP operations

metrics

RestMetricsClient metrics()

Server metrics

schemas

RestSchemaClient schemas()

Protobuf schemas

getConfiguration

RestClientConfiguration getConfiguration()

Returns the configuration of this RestClient

forConfiguration

static RestClient forConfiguration(RestClientConfiguration configuration)

Creates a RestClient instance based on the supplied configuration

Parameters:

configuration - a RestClientConfiguration

Returns:

a RestClient instance

security

RestSecurityClient security()

Server security