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

Interface ServiceActions

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
    Description
    org.codice.ddf.admin.configurator.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 Details

    • build

      org.codice.ddf.admin.configurator.Operation<Void> build(String configPid, Map<String,Object> configs, boolean keepIfNotPresent) throws org.codice.ddf.admin.configurator.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:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs creating the operator

    • read

      Map<String,Object> read(String configPid) throws org.codice.ddf.admin.configurator.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:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs reading state