io.scalecube.configuration.api

Interface ConfigurationService

public interface ConfigurationService

Configuration services manages Key / value json objects store. clients of the configuration service may save fetch list and delete entries from their store. read operations such as fetch and listing requires read level permissions. write operations such as save and delete requires write level operations. to verify the permissions each request to the configuration service consists with a Token, this token is created and managed by the account service. the configuration service validates the token with the account service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_CREATE_REPO
static String	CONFIG_DELETE
static String	CONFIG_ENTRIES
static String	CONFIG_FETCH
static String	CONFIG_SAVE

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Acknowledgment>	createRepository(CreateRepositoryRequest request) Request to create a configuration repository and requires a write level permissions.
reactor.core.publisher.Mono<Acknowledgment>	delete(DeleteRequest request) delete request requires write level permissions to delete entry from the store.
reactor.core.publisher.Flux<FetchResponse>	entries(FetchRequest request) Entries request requires read level permissions to list all entries objects from the store.
reactor.core.publisher.Mono<FetchResponse>	fetch(FetchRequest request) Fetch request requires read level permissions to get entry object from the store.
reactor.core.publisher.Mono<Acknowledgment>	save(SaveRequest request) Save request requires write level permissions to save (create or update) entry to the store.

Field Detail

CONFIG_CREATE_REPO

static final String CONFIG_CREATE_REPO

See Also:

Constant Field Values

CONFIG_FETCH

static final String CONFIG_FETCH

See Also:

Constant Field Values

CONFIG_ENTRIES

static final String CONFIG_ENTRIES

See Also:

Constant Field Values

CONFIG_SAVE

static final String CONFIG_SAVE

See Also:

Constant Field Values

CONFIG_DELETE

static final String CONFIG_DELETE

See Also:

Constant Field Values

Method Detail

createRepository

reactor.core.publisher.Mono<Acknowledgment> createRepository(CreateRepositoryRequest request)

Request to create a configuration repository and requires a write level permissions.

Parameters:

request - includes the repository and key of the requested object.

Returns:

Acknowledgment upon repository creation.

fetch

reactor.core.publisher.Mono<FetchResponse> fetch(FetchRequest request)

Fetch request requires read level permissions to get entry object from the store.

Parameters:

request - includes the repository and key of the requested object.

Returns:

json object from the store.

entries

reactor.core.publisher.Flux<FetchResponse> entries(FetchRequest request)

Entries request requires read level permissions to list all entries objects from the store.

Parameters:

request - includes the name of the repository to list.

Returns:

list of FetchResponses per each entry in the repository.

save

reactor.core.publisher.Mono<Acknowledgment> save(SaveRequest request)

Save request requires write level permissions to save (create or update) entry to the store.

Parameters:

request - includes the name of the repository, key, value to save.

Returns:

acknowledgement when saved.

delete

reactor.core.publisher.Mono<Acknowledgment> delete(DeleteRequest request)

delete request requires write level permissions to delete entry from the store.

Parameters:

request - includes the name of the repository, key to delete.

Returns:

acknowledgement when deleted.