Interface RemoteSchemasAdmin

All Known Implementing Classes:

RemoteSchemasAdminImpl

@Experimental
public interface RemoteSchemasAdmin

Manages schema operations such as create, update, delete, and retrieval.

Marked as Experimental as it may change.

Since:

16.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	RemoteSchemasAdmin.SchemaError	Holds a schema name and its associated error message.
static final record	RemoteSchemasAdmin.SchemaErrors	For multiple schema errors.
static class	RemoteSchemasAdmin.SchemaOpResult
static enum	RemoteSchemasAdmin.SchemaOpResultType

Method Summary

Modifier and Type	Method	Description
default Map<String, RemoteSchemasAdmin.SchemaOpResult>	create(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)	Creates schemas from a descriptor source.
default RemoteSchemasAdmin.SchemaOpResult	create(org.infinispan.protostream.schema.Schema schema)	Creates a new schema.
CompletionStage<Map<String, RemoteSchemasAdmin.SchemaOpResult>>	createAsync(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)	Non-blocking version of create(FileDescriptorSource)
CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	createAsync(org.infinispan.protostream.schema.Schema schema)	Non-blocking version of create(Schema)
default Map<String, RemoteSchemasAdmin.SchemaOpResult>	createOrUpdate(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)	Non-blocking version of createOrUpdate(FileDescriptorSource)
default RemoteSchemasAdmin.SchemaOpResult	createOrUpdate(org.infinispan.protostream.schema.Schema schema)	Creates or updates a schema.
default RemoteSchemasAdmin.SchemaOpResult	createOrUpdate(org.infinispan.protostream.schema.Schema schema, boolean force)	Creates or updates a schema.
CompletionStage<Map<String, RemoteSchemasAdmin.SchemaOpResult>>	createOrUpdateAsync(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)	Creates or updates schemas from descriptor source.
default CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	createOrUpdateAsync(org.infinispan.protostream.schema.Schema schema)	Non-blocking version of createOrUpdate(Schema)
CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	createOrUpdateAsync(org.infinispan.protostream.schema.Schema schema, boolean force)	Non-blocking version of createOrUpdate(Schema, boolean)
default boolean	exists(String schemaName)	Checks if the schema exists.
CompletionStage<Boolean>	existsAsync(String schemaName)	Non-blocking version of exists(String)
default Optional<org.infinispan.protostream.schema.Schema>	get(String schemaName)	Returns the schema by name.
CompletionStage<Optional<org.infinispan.protostream.schema.Schema>>	getAsync(String schemaName)	Non-blocking version of get(String)
default RemoteSchemasAdmin.SchemaOpResult	remove(String schemaName)	Deletes a schema.
default RemoteSchemasAdmin.SchemaOpResult	remove(String schemaName, boolean force)	Deletes a schema with optional force.
default CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	removeAsync(String schemaName)	Non-blocking version of remove(String)
CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	removeAsync(String schemaName, boolean force)	Non-blocking version of remove(String, boolean)
default RemoteSchemasAdmin.SchemaErrors	retrieveAllSchemaErrors()	Returns all schema errors.
CompletionStage<RemoteSchemasAdmin.SchemaErrors>	retrieveAllSchemaErrorsAsync()	Non-blocking version of retrieveAllSchemaErrors()
default Optional<String>	retrieveError(String schemaName)	Returns the schema error, if present.
CompletionStage<Optional<String>>	retrieveErrorAsync(String schemaName)	Non-blocking version of retrieveError(String)
default Map<String, RemoteSchemasAdmin.SchemaOpResult>	update(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)	Updates schemas from a descriptor source.
default RemoteSchemasAdmin.SchemaOpResult	update(org.infinispan.protostream.schema.Schema schema)	Updates an existing schema.
default RemoteSchemasAdmin.SchemaOpResult	update(org.infinispan.protostream.schema.Schema schema, boolean force)	Updates an existing schema with optional force.
CompletionStage<Map<String, RemoteSchemasAdmin.SchemaOpResult>>	updateAsync(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)	Non-blocking version of update(FileDescriptorSource)
default CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	updateAsync(org.infinispan.protostream.schema.Schema schema)	Non-blocking version of update(Schema)
CompletionStage<RemoteSchemasAdmin.SchemaOpResult>	updateAsync(org.infinispan.protostream.schema.Schema schema, boolean force)	Non-blocking version of update(Schema, boolean)

Method Details

get

default Optional<org.infinispan.protostream.schema.Schema> get(String schemaName)

Returns the schema by name.

Parameters:

schemaName - schema name

Returns:

optional schema

getAsync

CompletionStage<Optional<org.infinispan.protostream.schema.Schema>> getAsync(String schemaName)

Non-blocking version of get(String)

retrieveError

default Optional<String> retrieveError(String schemaName)

Returns the schema error, if present.

Parameters:

schemaName - schema name

Returns:

optional schema error

retrieveErrorAsync

CompletionStage<Optional<String>> retrieveErrorAsync(String schemaName)

Non-blocking version of retrieveError(String)

retrieveAllSchemaErrors

default RemoteSchemasAdmin.SchemaErrors retrieveAllSchemaErrors()

Returns all schema errors.

Returns:

all schema errors

retrieveAllSchemaErrorsAsync

CompletionStage<RemoteSchemasAdmin.SchemaErrors> retrieveAllSchemaErrorsAsync()

Non-blocking version of retrieveAllSchemaErrors()

create

default RemoteSchemasAdmin.SchemaOpResult create(org.infinispan.protostream.schema.Schema schema)

Creates a new schema.

Parameters:

schema - the schema to create

Returns:

RemoteSchemasAdmin.SchemaOpResult containing the op result RemoteSchemasAdmin.SchemaOpResultType.CREATED, RemoteSchemasAdmin.SchemaOpResultType.NONE and the schema validation error, if such exists

createAsync

CompletionStage<RemoteSchemasAdmin.SchemaOpResult> createAsync(org.infinispan.protostream.schema.Schema schema)

Non-blocking version of create(Schema)

create

default Map<String, RemoteSchemasAdmin.SchemaOpResult> create(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)

Creates schemas from a descriptor source.

Parameters:

fileDescriptorSource - descriptor source

Returns:

map of schema names to results

createAsync

CompletionStage<Map<String, RemoteSchemasAdmin.SchemaOpResult>> createAsync(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)

Non-blocking version of create(FileDescriptorSource)

update

default RemoteSchemasAdmin.SchemaOpResult update(org.infinispan.protostream.schema.Schema schema)

Updates an existing schema. Retrieves the current schema value. If the schema has changed by the time the update occurs, the update is skipped. This prevents overwriting changes made by another node.

Parameters:

schema - the schema to update

Returns:

RemoteSchemasAdmin.SchemaOpResult containing the op result RemoteSchemasAdmin.SchemaOpResultType.UPDATED, RemoteSchemasAdmin.SchemaOpResultType.NONE and the schema validation error, if such exists

update

default RemoteSchemasAdmin.SchemaOpResult update(org.infinispan.protostream.schema.Schema schema,
 boolean force)

Updates an existing schema with optional force. If force=false, retrieves the current schema value. If the schema has changed by the time the update occurs, the update is skipped. This prevents overwriting changes made by another node. If force=true, the update is done on every case.

Parameters:

schema - the schema to update

force - , if true checks the version of the schema

Returns:

RemoteSchemasAdmin.SchemaOpResult containing the op result RemoteSchemasAdmin.SchemaOpResultType.UPDATED, RemoteSchemasAdmin.SchemaOpResultType.NONE and the schema validation error, if such exists

updateAsync

default CompletionStage<RemoteSchemasAdmin.SchemaOpResult> updateAsync(org.infinispan.protostream.schema.Schema schema)

Non-blocking version of update(Schema)

updateAsync

CompletionStage<RemoteSchemasAdmin.SchemaOpResult> updateAsync(org.infinispan.protostream.schema.Schema schema,
 boolean force)

Non-blocking version of update(Schema, boolean)

update

default Map<String, RemoteSchemasAdmin.SchemaOpResult> update(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)

Updates schemas from a descriptor source.

Parameters:

fileDescriptorSource - descriptor source

Returns:

map of schema names to results

updateAsync

CompletionStage<Map<String, RemoteSchemasAdmin.SchemaOpResult>> updateAsync(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)

Non-blocking version of update(FileDescriptorSource)

createOrUpdate

default RemoteSchemasAdmin.SchemaOpResult createOrUpdate(org.infinispan.protostream.schema.Schema schema)

Creates or updates a schema.

Parameters:

schema - the schema to create or update

Returns:

RemoteSchemasAdmin.SchemaOpResult containing the op result RemoteSchemasAdmin.SchemaOpResultType.CREATED, RemoteSchemasAdmin.SchemaOpResultType.UPDATED, or RemoteSchemasAdmin.SchemaOpResultType.NONE and the schema validation error, if such exists

createOrUpdate

default RemoteSchemasAdmin.SchemaOpResult createOrUpdate(org.infinispan.protostream.schema.Schema schema,
 boolean force)

Creates or updates a schema. If force=false, retrieves the current schema value. If the schema has changed by the time the operation occurs, the creation or the update is skipped. This prevents overwriting changes made by another node. If force=true, the creation or the update is done on every case.

Parameters:

schema - the schema to create or update

force - force the schema create or update

Returns:

RemoteSchemasAdmin.SchemaOpResult containing the op result RemoteSchemasAdmin.SchemaOpResultType.CREATED, RemoteSchemasAdmin.SchemaOpResultType.UPDATED, or RemoteSchemasAdmin.SchemaOpResultType.NONE and the schema validation error, if such exists

createOrUpdateAsync

default CompletionStage<RemoteSchemasAdmin.SchemaOpResult> createOrUpdateAsync(org.infinispan.protostream.schema.Schema schema)

Non-blocking version of createOrUpdate(Schema)

createOrUpdateAsync

CompletionStage<RemoteSchemasAdmin.SchemaOpResult> createOrUpdateAsync(org.infinispan.protostream.schema.Schema schema,
 boolean force)

Non-blocking version of createOrUpdate(Schema, boolean)

createOrUpdate

default Map<String, RemoteSchemasAdmin.SchemaOpResult> createOrUpdate(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)

Non-blocking version of createOrUpdate(FileDescriptorSource)

createOrUpdateAsync

CompletionStage<Map<String, RemoteSchemasAdmin.SchemaOpResult>> createOrUpdateAsync(org.infinispan.protostream.FileDescriptorSource fileDescriptorSource)

Creates or updates schemas from descriptor source.

Parameters:

fileDescriptorSource - source of schema descriptors

Returns:

map of schema names to results

remove

default RemoteSchemasAdmin.SchemaOpResult remove(String schemaName)

Deletes a schema. Does not force deletion. If the method is invoked while a cache already holds a reference to a schema entity, an exception is thrown.

Parameters:

schemaName - schema name

Returns:

RemoteSchemasAdmin.SchemaOpResultType.DELETED if deleted, RemoteSchemasAdmin.SchemaOpResultType.NONE if not found

Throws:

org.infinispan.api.exception.InfinispanException - if deletion is blocked by cache dependencies

remove

default RemoteSchemasAdmin.SchemaOpResult remove(String schemaName,
 boolean force)

Deletes a schema with optional force. If the method is invoked while a cache already holds a reference to a schema entity, an exception is thrown if force=false. Setting force=true bypasses this check and deletes the schema, if such exists.

Parameters:

schemaName - schema name

force - if true, bypasses dependency checks

Returns:

RemoteSchemasAdmin.SchemaOpResultType.DELETED if deleted, RemoteSchemasAdmin.SchemaOpResultType.NONE if not found

Throws:

org.infinispan.api.exception.InfinispanException - if not forced and schema is in use

removeAsync

default CompletionStage<RemoteSchemasAdmin.SchemaOpResult> removeAsync(String schemaName)

Non-blocking version of remove(String)

removeAsync

CompletionStage<RemoteSchemasAdmin.SchemaOpResult> removeAsync(String schemaName,
 boolean force)

Non-blocking version of remove(String, boolean)

exists

default boolean exists(String schemaName)

Checks if the schema exists.

Parameters:

schemaName - schema name

Returns:

true if exists, false otherwise

existsAsync

CompletionStage<Boolean> existsAsync(String schemaName)

Non-blocking version of exists(String)