Package org.infinispan.client.rest

Interface RestCacheClient

All Known Implementing Classes:

RestCacheClientOkHttp

public interface RestCacheClient

Since:

10.0

Author:

Tristan Tarrant <tristan@infinispan.org>

Method Summary

Modifier and Type	Method	Description
CompletionStage<RestResponse>	backupStatus(String site)
CompletionStage<RestResponse>	bringSiteOnline(String site)	Bring back a backup site online
CompletionStage<RestResponse>	cancelPushState(String site)	Cancels the state push
CompletionStage<RestResponse>	cancelReceiveState(String site)	Cancel the receiving state on a backup site
CompletionStage<RestResponse>	clear()	Clears a cache
CompletionStage<RestResponse>	clearIndex()	Deletes all the indexes from the cache.
CompletionStage<RestResponse>	clearPushStateStatus()	Clear the status of a state push in a site
CompletionStage<RestResponse>	clearQueryStats()	Deprecated, for removal: This API element is subject to removal in a future version. Use searchStats() and clearSearchStats().
CompletionStage<RestResponse>	clearSearchStats()	Clear search stats.
default CompletionStage<RestResponse>	configuration()	Retrieves the cache configuration
CompletionStage<RestResponse>	configuration(String mediaType)	Retrieves the cache configuration with a specific MediaType or list of MediaTypes.
CompletionStage<RestResponse>	configurationAttributes()	Retrieves all available configuration attributes for this cache
CompletionStage<RestResponse>	configurationAttributes(boolean full)	Retrieves all available configuration attributes for this cache optionally including values and types
CompletionStage<RestResponse>	connectSource(RestEntity remoteStoreJsonConfig)	Connects the target cluster to a source cluster before a Rolling Upgrade
CompletionStage<RestResponse>	createWithConfiguration(RestEntity configuration, org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)	Creates the cache using the supplied configuration
CompletionStage<RestResponse>	createWithTemplate(String template, org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)	Creates the cache using the supplied template name
CompletionStage<RestResponse>	delete()	Removes the cache
CompletionStage<RestResponse>	details()	Obtains details about the cache
CompletionStage<RestResponse>	disableRebalancing()	Disables automatic rebalancing for the cache.
CompletionStage<RestResponse>	disconnectSource()	Disconnects the target cluster from the source cluster after a Rolling Upgrade
CompletionStage<RestResponse>	distribution()	Obtain metrics about the distribution of data of the cache.
CompletionStage<RestResponse>	enableRebalancing()	Enables automatic rebalancing for the cache.
default CompletionStage<RestResponse>	entries()	Retrieves entries without metadata
CompletionStage<RestResponse>	entries(boolean contentNegotiation)	Retrieves entries without metadata
CompletionStage<RestResponse>	entries(int limit)	Retrieves entries limited by count
CompletionStage<RestResponse>	entries(int limit, boolean metadata)	Retrieves entries with limit and metadata
CompletionStage<RestResponse>	exists()	Check if the cache exists
CompletionStage<RestResponse>	get(String key)	GETs a key from the cache
CompletionStage<RestResponse>	get(String key, String mediaType)	GETs a key from the cache with a specific MediaType or list of MediaTypes.
CompletionStage<RestResponse>	get(String key, String mediaType, boolean extended)	Same as get(String, String) but with an option to return extended headers.
CompletionStage<RestResponse>	get(String key, Map<String,String> headers)	Same as get(String) but allowing custom headers.
CompletionStage<RestResponse>	getAvailability()	Retrieves the Cache's Availability status.
CompletionStage<RestResponse>	getXSiteTakeOfflineConfig(String site)	Get the configuration used to automatically take a backup site offline
CompletionStage<RestResponse>	head(String key)	Similar to get(String) but only retrieves headers
CompletionStage<RestResponse>	head(String key, Map<String,String> headers)	Similar to head(String) but allowing custom headers
CompletionStage<RestResponse>	indexMetamodel()	Obtains the index metamodel for the current cache.
CompletionStage<RestResponse>	indexStats()	Deprecated, for removal: This API element is subject to removal in a future version. Use searchStats() instead.
CompletionStage<RestResponse>	keys()	Retrieve all keys
CompletionStage<RestResponse>	keys(int limit)	Retrieve keys limited by count
CompletionStage<RestResponse>	keys(String mediaType)	Retrieves all keys from the cache with a specific MediaType or list of MediaTypes.
CompletionStage<RestResponse>	markTopologyStable(boolean force)	Force the current cache topology as the stable if not running.
String	name()	Returns the name of the cache
CompletionStage<RestResponse>	post(String key, String value)	POSTs a key/value to the cache as text/plain
CompletionStage<RestResponse>	post(String key, String value, long ttl, long maxIdle)	POSTs a key/value to the cache as text/plain with the specified expiration
CompletionStage<RestResponse>	post(String key, RestEntity value)	POSTs a key/value to the cache with the specified encoding
CompletionStage<RestResponse>	post(String key, RestEntity value, long ttl, long maxIdle)	POSTs a key/value to the cache with the specified encoding and expiration
CompletionStage<RestResponse>	pushSiteState(String site)	Starts the state push to a backup site
CompletionStage<RestResponse>	pushStateStatus()	Obtain the status of a state push to a backup site
CompletionStage<RestResponse>	put(String key, String value)	PUTs a key/value to the cache as text/plain
CompletionStage<RestResponse>	put(String key, String value, long ttl, long maxIdle)	PUTs a key/value to the cache as text/plain with the specified expiration
CompletionStage<RestResponse>	put(String key, String keyContentType, RestEntity value)	PUT a key/value to the cache with custom media types for keys and values
CompletionStage<RestResponse>	put(String key, String keyContentType, RestEntity value, long ttl, long maxIdle)	PUT an entry with metadata.
CompletionStage<RestResponse>	put(String key, String keyContentType, RestEntity value, Map<String,String> headers)	Same as put(String, String, RestEntity) but allowing custom headers.
CompletionStage<RestResponse>	put(String key, RestEntity value)	PUTs a key/value to the cache with the specified encoding
CompletionStage<RestResponse>	put(String key, RestEntity value, long ttl, long maxIdle)	PUTs a key/value to the cache with the specified encoding and expiration
CompletionStage<RestResponse>	put(String key, RestEntity value, String... flags)	Same as put(String, RestEntity) also allowing one or more invalid reference org.infinispan.context.Flag to be passed.
default CompletionStage<RestResponse>	query(String query)	Executes an Ickle-query
CompletionStage<RestResponse>	query(String query, boolean local)	Executes an Ickle-query
CompletionStage<RestResponse>	query(String query, int maxResults, int offset)	Executes an Ickle-query
CompletionStage<RestResponse>	query(String query, int maxResults, int offset, int hitCountAccuracy)	Executes an Ickle-query
CompletionStage<RestResponse>	queryStats()	Deprecated, for removal: This API element is subject to removal in a future version. Use searchStats() instead.
CompletionStage<RestResponse>	reindex()	Rebuild the search indexes of the cache based on its data.
CompletionStage<RestResponse>	reindexLocal()	Same as reindex() but only considers data from the local cluster member.
CompletionStage<RestResponse>	remove(String key)	DELETEs an entry from the cache
CompletionStage<RestResponse>	remove(String test, Map<String,String> headers)	Same as remove(String) but allowing custom headers
CompletionStage<RestResponse>	searchStats()	Obtain query and indexing statistics for the cache.
CompletionStage<RestResponse>	setAvailability(String availability)	Sets the Cache's Avaialability
CompletionStage<RestResponse>	size()	Obtains the total number of elements in the cache
CompletionStage<RestResponse>	sourceConnected()	Checks if the cache is connected through a remote store to perform rolling upgrades
CompletionStage<RestResponse>	sourceConnection()	Return the remote store configuration in case the case has been connected to another cluster using connectSource(RestEntity)
CompletionStage<RestResponse>	stats()	Obtains statistics for the cache
CompletionStage<RestResponse>	synchronizeData()	Execute a Rolling Upgrade processing using defaults.
CompletionStage<RestResponse>	synchronizeData(Integer readBatch, Integer threads)	Execute a Rolling Upgrade processing
CompletionStage<RestResponse>	takeSiteOffline(String site)	Take a backup site offline
CompletionStage<RestResponse>	updateConfigurationAttribute(String attribute, String value)	Updates a configuration attribute.
CompletionStage<RestResponse>	updateIndexSchema()	Update index schema for the current cache.
CompletionStage<RestResponse>	updateWithConfiguration(RestEntity configuration, org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)	Updates the cache configuration
CompletionStage<RestResponse>	updateXSiteTakeOfflineConfig(String site, int afterFailures, long minTimeToWait)	Updates the configuration used to automatically take a backup site offline
CompletionStage<RestResponse>	xsiteBackups()
CompletionStage<RestResponse>	xSiteStateTransferMode(String site)	Returns the cross-site replication state transfer mode.
CompletionStage<RestResponse>	xSiteStateTransferMode(String site, org.infinispan.configuration.cache.XSiteStateTransferMode mode)	Sets the cross-site replication state transfer mode.

Method Details

name

String name()

Returns the name of the cache

keys

CompletionStage<RestResponse> keys()

Retrieve all keys

Returns:

Response with inputStream to get all the keys

keys

CompletionStage<RestResponse> keys(int limit)

Retrieve keys limited by count

Parameters:

limit - The maximum number of keys to retrieve

Returns:

Response with InputStream to get the keys

entries

default CompletionStage<RestResponse> entries()

Retrieves entries without metadata

Returns:

Response with InputStream to get the entries

entries

CompletionStage<RestResponse> entries(boolean contentNegotiation)

Retrieves entries without metadata

Parameters:

contentNegotiation - if true, the server will convert keys and values to a readable format and return headers with the negotiated media type.

Returns:

Response with InputStream to get the entries

entries

CompletionStage<RestResponse> entries(int limit)

Retrieves entries limited by count

Parameters:

limit - : The maximum number of entries to retrieve, or -1 to retrieve all

entries

CompletionStage<RestResponse> entries(int limit,
 boolean metadata)

Retrieves entries with limit and metadata

Parameters:

limit - : The maximum number of entries to retrieve, or -1 to retrieve all

metadata - : if true, includes the metadata for each entry

keys

CompletionStage<RestResponse> keys(String mediaType)

Retrieves all keys from the cache with a specific MediaType or list of MediaTypes.

configuration

default CompletionStage<RestResponse> configuration()

Retrieves the cache configuration

configuration

CompletionStage<RestResponse> configuration(String mediaType)

Retrieves the cache configuration with a specific MediaType or list of MediaTypes.

clear

CompletionStage<RestResponse> clear()

Clears a cache

size

CompletionStage<RestResponse> size()

Obtains the total number of elements in the cache

post

CompletionStage<RestResponse> post(String key,
 String value)

POSTs a key/value to the cache as text/plain

Parameters:

key -

value -

Returns:

post

CompletionStage<RestResponse> post(String key,
 String value,
 long ttl,
 long maxIdle)

POSTs a key/value to the cache as text/plain with the specified expiration

Parameters:

key -

value -

ttl -

maxIdle -

Returns:

post

CompletionStage<RestResponse> post(String key,
 RestEntity value)

POSTs a key/value to the cache with the specified encoding

Parameters:

key -

value -

Returns:

post

CompletionStage<RestResponse> post(String key,
 RestEntity value,
 long ttl,
 long maxIdle)

POSTs a key/value to the cache with the specified encoding and expiration

Parameters:

key -

value -

ttl -

maxIdle -

Returns:

put

CompletionStage<RestResponse> put(String key,
 String value)

PUTs a key/value to the cache as text/plain

Parameters:

key -

value -

Returns:

put

CompletionStage<RestResponse> put(String key,
 String keyContentType,
 RestEntity value)

PUT a key/value to the cache with custom media types for keys and values

put

CompletionStage<RestResponse> put(String key,
 String keyContentType,
 RestEntity value,
 Map<String,String> headers)

Same as put(String, String, RestEntity) but allowing custom headers.

put

CompletionStage<RestResponse> put(String key,
 String keyContentType,
 RestEntity value,
 long ttl,
 long maxIdle)

PUT an entry with metadata.

Parameters:

key - The key

keyContentType - The MediaType of the key

value - a RestEntity containing the value and its MediaType

ttl - The time to live value

maxIdle - The max idle value

Returns:

put

CompletionStage<RestResponse> put(String key,
 String value,
 long ttl,
 long maxIdle)

PUTs a key/value to the cache as text/plain with the specified expiration

Parameters:

key -

value -

ttl -

maxIdle -

Returns:

put

CompletionStage<RestResponse> put(String key,
 RestEntity value)

PUTs a key/value to the cache with the specified encoding

Parameters:

key -

value -

Returns:

put

CompletionStage<RestResponse> put(String key,
 RestEntity value,
 String... flags)

Same as put(String, RestEntity) also allowing one or more

invalid reference

org.infinispan.context.Flag

to be passed.

put

CompletionStage<RestResponse> put(String key,
 RestEntity value,
 long ttl,
 long maxIdle)

PUTs a key/value to the cache with the specified encoding and expiration

Parameters:

key -

value -

ttl -

maxIdle -

Returns:

get

CompletionStage<RestResponse> get(String key)

GETs a key from the cache

Parameters:

key -

Returns:

get

CompletionStage<RestResponse> get(String key,
 Map<String,String> headers)

Same as get(String) but allowing custom headers.

get

CompletionStage<RestResponse> get(String key,
 String mediaType)

GETs a key from the cache with a specific MediaType or list of MediaTypes.

get

CompletionStage<RestResponse> get(String key,
 String mediaType,
 boolean extended)

Same as get(String, String) but with an option to return extended headers.

head

CompletionStage<RestResponse> head(String key)

Similar to get(String) but only retrieves headers

Parameters:

key -

Returns:

head

CompletionStage<RestResponse> head(String key,
 Map<String,String> headers)

Similar to head(String) but allowing custom headers

remove

CompletionStage<RestResponse> remove(String key)

DELETEs an entry from the cache

Parameters:

key -

Returns:

remove

CompletionStage<RestResponse> remove(String test,
 Map<String,String> headers)

Same as remove(String) but allowing custom headers

createWithTemplate

CompletionStage<RestResponse> createWithTemplate(String template,
 org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)

Creates the cache using the supplied template name

Parameters:

template - the name of a template

flags - any flags to apply to the create operation, e.g. CacheContainerAdmin.AdminFlag.VOLATILE

Returns:

stats

CompletionStage<RestResponse> stats()

Obtains statistics for the cache

Returns:

distribution

CompletionStage<RestResponse> distribution()

Obtain metrics about the distribution of data of the cache.

Returns:

createWithConfiguration

CompletionStage<RestResponse> createWithConfiguration(RestEntity configuration,
 org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)

Creates the cache using the supplied configuration

Parameters:

configuration - the configuration, in XML, JSON or YAML format

flags - any flags to apply to the create operation, e.g. CacheContainerAdmin.AdminFlag.VOLATILE

Returns:

updateWithConfiguration

CompletionStage<RestResponse> updateWithConfiguration(RestEntity configuration,
 org.infinispan.commons.api.CacheContainerAdmin.AdminFlag... flags)

Updates the cache configuration

Parameters:

configuration - the configuration, in XML, JSON or YAML format

flags - any flags to apply to the update operation, e.g. CacheContainerAdmin.AdminFlag.VOLATILE

Returns:

delete

CompletionStage<RestResponse> delete()

Removes the cache

Returns:

query

default CompletionStage<RestResponse> query(String query)

Executes an Ickle-query

Parameters:

query - the ickle query

query

CompletionStage<RestResponse> query(String query,
 boolean local)

Executes an Ickle-query

Parameters:

query - the ickle query

local - if true, query is restricted to the data present in the node that process the request.

query

CompletionStage<RestResponse> query(String query,
 int maxResults,
 int offset)

Executes an Ickle-query

Parameters:

query - the ickle query

maxResults - the maximum number of results to return

offset - the offset within the result from which to return results

query

CompletionStage<RestResponse> query(String query,
 int maxResults,
 int offset,
 int hitCountAccuracy)

Executes an Ickle-query

Parameters:

query - the ickle query

maxResults - the maximum number of results to return

offset - the offset within the result from which to return results

hitCountAccuracy - the limit to the hit count accuracy to return sooner

xsiteBackups

CompletionStage<RestResponse> xsiteBackups()

Returns:

the status of all backup sites

backupStatus

CompletionStage<RestResponse> backupStatus(String site)

Returns:

the status of a single backup site

takeSiteOffline

CompletionStage<RestResponse> takeSiteOffline(String site)

Take a backup site offline

bringSiteOnline

CompletionStage<RestResponse> bringSiteOnline(String site)

Bring back a backup site online

pushSiteState

CompletionStage<RestResponse> pushSiteState(String site)

Starts the state push to a backup site

cancelPushState

CompletionStage<RestResponse> cancelPushState(String site)

Cancels the state push

cancelReceiveState

CompletionStage<RestResponse> cancelReceiveState(String site)

Cancel the receiving state on a backup site

pushStateStatus

CompletionStage<RestResponse> pushStateStatus()

Obtain the status of a state push to a backup site

getXSiteTakeOfflineConfig

CompletionStage<RestResponse> getXSiteTakeOfflineConfig(String site)

Get the configuration used to automatically take a backup site offline

updateXSiteTakeOfflineConfig

CompletionStage<RestResponse> updateXSiteTakeOfflineConfig(String site,
 int afterFailures,
 long minTimeToWait)

Updates the configuration used to automatically take a backup site offline

clearPushStateStatus

CompletionStage<RestResponse> clearPushStateStatus()

Clear the status of a state push in a site

xSiteStateTransferMode

CompletionStage<RestResponse> xSiteStateTransferMode(String site)

Returns the cross-site replication state transfer mode.

See Also:

• XSiteStateTransferMode

xSiteStateTransferMode

CompletionStage<RestResponse> xSiteStateTransferMode(String site,
 org.infinispan.configuration.cache.XSiteStateTransferMode mode)

Sets the cross-site replication state transfer mode.

See Also:

• XSiteStateTransferMode

exists

CompletionStage<RestResponse> exists()

Check if the cache exists

synchronizeData

CompletionStage<RestResponse> synchronizeData(Integer readBatch,
 Integer threads)

Execute a Rolling Upgrade processing

synchronizeData

CompletionStage<RestResponse> synchronizeData()

Execute a Rolling Upgrade processing using defaults.

disconnectSource

CompletionStage<RestResponse> disconnectSource()

Disconnects the target cluster from the source cluster after a Rolling Upgrade

connectSource

CompletionStage<RestResponse> connectSource(RestEntity remoteStoreJsonConfig)

Connects the target cluster to a source cluster before a Rolling Upgrade

Parameters:

remoteStoreJsonConfig - The remote-store config as JSON

sourceConnected

CompletionStage<RestResponse> sourceConnected()

Checks if the cache is connected through a remote store to perform rolling upgrades

sourceConnection

CompletionStage<RestResponse> sourceConnection()

Return the remote store configuration in case the case has been connected to another cluster using connectSource(RestEntity)

reindex

CompletionStage<RestResponse> reindex()

Rebuild the search indexes of the cache based on its data.

reindexLocal

CompletionStage<RestResponse> reindexLocal()

Same as reindex() but only considers data from the local cluster member.

clearIndex

CompletionStage<RestResponse> clearIndex()

Deletes all the indexes from the cache.

updateIndexSchema

CompletionStage<RestResponse> updateIndexSchema()

Update index schema for the current cache.

queryStats

@Deprecated(forRemoval=true)
CompletionStage<RestResponse> queryStats()

Deprecated, for removal: This API element is subject to removal in a future version.

Use searchStats() instead.

Obtain statistics about queries.

indexStats

@Deprecated(forRemoval=true)
CompletionStage<RestResponse> indexStats()

Deprecated, for removal: This API element is subject to removal in a future version.

Use searchStats() instead.

Obtain statistics about the indexes.

clearQueryStats

@Deprecated(forRemoval=true)
CompletionStage<RestResponse> clearQueryStats()

Deprecated, for removal: This API element is subject to removal in a future version.

Use searchStats() and clearSearchStats().

Clear runtime query statistics.

details

CompletionStage<RestResponse> details()

Obtains details about the cache

indexMetamodel

CompletionStage<RestResponse> indexMetamodel()

Obtains the index metamodel for the current cache. The query has to be indexed.

Returns:

the stage of the response containing the metamodel of the index

searchStats

CompletionStage<RestResponse> searchStats()

Obtain query and indexing statistics for the cache.

clearSearchStats

CompletionStage<RestResponse> clearSearchStats()

Clear search stats.

enableRebalancing

CompletionStage<RestResponse> enableRebalancing()

Enables automatic rebalancing for the cache.

disableRebalancing

CompletionStage<RestResponse> disableRebalancing()

Disables automatic rebalancing for the cache.

updateConfigurationAttribute

CompletionStage<RestResponse> updateConfigurationAttribute(String attribute,
 String value)

Updates a configuration attribute.

configurationAttributes

CompletionStage<RestResponse> configurationAttributes()

Retrieves all available configuration attributes for this cache

configurationAttributes

CompletionStage<RestResponse> configurationAttributes(boolean full)

Retrieves all available configuration attributes for this cache optionally including values and types

getAvailability

CompletionStage<RestResponse> getAvailability()

Retrieves the Cache's Availability status.

setAvailability

CompletionStage<RestResponse> setAvailability(String availability)

Sets the Cache's Avaialability

markTopologyStable

CompletionStage<RestResponse> markTopologyStable(boolean force)

Force the current cache topology as the stable if not running.