org.codice.ddf.internal.admin.configurator.actions

Interface ServiceActions

All Known Implementing Classes:

ServiceOperation.Actions

public interface ServiceActions

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method and Description
Operation<Void>	build(String configPid, Map<String,Object> configs, boolean keepIfNotPresent) Creates a handler for persisting changes to a bundle configuration.
Map<String,Object>	read(String configPid) Gets the current key:value pairs set in the given configuration file.

Method Detail

build

Operation<Void> build(String configPid,
                      Map<String,Object> configs,
                      boolean keepIfNotPresent)
               throws ConfiguratorException

Creates a handler for persisting changes to a bundle configuration.

Parameters:

configPid - the configPid of the bundle configuration to be updated

configs - map of key:value pairs to be written to the configuration

keepIfNotPresent - if true, any keys in the current config file that are not in the configs map will be left with their initial values; if false, they will be removed from the file

Returns:

handler to persist configuration

Throws:

ConfiguratorException - if an error occurs creating the operator

read

Map<String,Object> read(String configPid)
                 throws ConfiguratorException

Gets the current key:value pairs set in the given configuration file.

Parameters:

configPid - the configId of the bundle configuration file to query

Returns:

the current set of key:value pairs

Throws:

ConfiguratorException - if an error occurs reading state