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 apiKey is created and managed by the account service. the configuration service validates the apiKey with the account service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_CREATE_ENTRY
static String	CONFIG_CREATE_REPO
static String	CONFIG_DELETE_ENTRY
static String	CONFIG_READ_ENTRY
static String	CONFIG_READ_ENTRY_HISTORY
static String	CONFIG_READ_LIST
static String	CONFIG_UPDATE_ENTRY

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<VersionAcknowledgment>	createEntry(CreateOrUpdateEntryRequest request) Save request requires write level permissions to save (create or update) entry to the store.
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>	deleteEntry(DeleteEntryRequest request) delete request requires write level permissions to delete entry from the store.
reactor.core.publisher.Mono<ReadEntryResponse>	readEntry(ReadEntryRequest request) Fetch request requires read level permissions to get entry object from the store.
reactor.core.publisher.Mono<List<ReadEntryHistoryResponse>>	readEntryHistory(ReadEntryHistoryRequest request) The request requires read level permissions to get entry object from the store.
reactor.core.publisher.Mono<List<ReadEntryResponse>>	readList(ReadListRequest request) Entries request requires read level permissions to list all entries objects from the store.
reactor.core.publisher.Mono<VersionAcknowledgment>	updateEntry(CreateOrUpdateEntryRequest request) Update request requires write level permissions to update entry to the store.

Field Detail

CONFIG_CREATE_REPO

static final String CONFIG_CREATE_REPO

See Also:

Constant Field Values

CONFIG_READ_ENTRY

static final String CONFIG_READ_ENTRY

See Also:

Constant Field Values

CONFIG_READ_ENTRY_HISTORY

static final String CONFIG_READ_ENTRY_HISTORY

See Also:

Constant Field Values

CONFIG_READ_LIST

static final String CONFIG_READ_LIST

See Also:

Constant Field Values

CONFIG_CREATE_ENTRY

static final String CONFIG_CREATE_ENTRY

See Also:

Constant Field Values

CONFIG_UPDATE_ENTRY

static final String CONFIG_UPDATE_ENTRY

See Also:

Constant Field Values

CONFIG_DELETE_ENTRY

static final String CONFIG_DELETE_ENTRY

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.

readEntry

reactor.core.publisher.Mono<ReadEntryResponse> readEntry(ReadEntryRequest 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.

readList

reactor.core.publisher.Mono<List<ReadEntryResponse>> readList(ReadListRequest 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.

readEntryHistory

reactor.core.publisher.Mono<List<ReadEntryHistoryResponse>> readEntryHistory(ReadEntryHistoryRequest request)

The 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.

createEntry

reactor.core.publisher.Mono<VersionAcknowledgment> createEntry(CreateOrUpdateEntryRequest 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.

updateEntry

reactor.core.publisher.Mono<VersionAcknowledgment> updateEntry(CreateOrUpdateEntryRequest request)

Update request requires write level permissions to update entry to the store.

Parameters:

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

Returns:

acknowledgement when updated.

deleteEntry

reactor.core.publisher.Mono<Acknowledgment> deleteEntry(DeleteEntryRequest 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.