org.thales.punch.settings.api

Interface IConfigurationStore

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FileSystemConfigurationStoreImpl

public interface IConfigurationStore
extends AutoCloseable

To save or load configuration, use this interface. The punch provides a kafka and a (plain) filesystem implementation.

On a single node punch system for example, no need to have a kafka. The configuration is simply stored on the local filesystem.

On a clustered punch or on a single node but equipped with Kafka, Kafka is in action.

Method Summary

Modifier and Type	Method and Description
boolean	checkIfPathExist(String path)
default void	close() Close the client client and any underlying resource.
ISettingsMap	readMap(String path) Read a Json encoded content from your store.
default void	refresh()
void	rmr(String string) Completely remove a path and all its childs
default IConfigurationStore	startBlocking() Starts and wait until connected.
void	writeMap(ISettingsMap map, String path) Write a map as a Json string the admin database

Method Detail

readMap

ISettingsMap readMap(String path)

Read a Json encoded content from your store.

Parameters:

path - the path of the data you want

Returns:

a Map. In case of problem an empty map is returned.

writeMap

void writeMap(ISettingsMap map,
              String path)

Write a map as a Json string the admin database

Parameters:

map - your settings map

path - the path of the data you want

startBlocking

default IConfigurationStore startBlocking()

Starts and wait until connected.

Returns:

this client

close

default void close()

Close the client client and any underlying resource.

Specified by:

close in interface AutoCloseable

checkIfPathExist

boolean checkIfPathExist(String path)

Parameters:

path - a configuration node path

Returns:

true if the provided path exists

rmr

void rmr(String string)

Completely remove a path and all its childs

Parameters:

string - the path you want to remove

refresh

default void refresh()
              throws TimeoutException

Throws:

TimeoutException