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

Interface ManagedServiceActions

public interface ManagedServiceActions
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<String>
    create(String factoryPid, Map<String,Object> configs)
    Creates a handler that will create a managed service as part of a transaction.
    org.codice.ddf.admin.configurator.Operation<String>
    delete(String pid)
    Creates a handler that will delete a managed service as part of a transaction.
    Map<String,Map<String,Object>>
    read(String factoryPid)
    For the given managed service factory, retrieves the full complement of configuration properties.

  • Method Details

    • create

      org.codice.ddf.admin.configurator.Operation<String> create(String factoryPid, Map<String,Object> configs) throws org.codice.ddf.admin.configurator.ConfiguratorException
      Creates a handler that will create a managed service as part of a transaction.
      Parameters:
      factoryPid - the PID of the service factory
      configs - the configuration properties to apply to the service
      Returns:
      a service operation object
      Throws:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs creating the operator

    • delete

      org.codice.ddf.admin.configurator.Operation<String> delete(String pid) throws org.codice.ddf.admin.configurator.ConfiguratorException
      Creates a handler that will delete a managed service as part of a transaction.
      Parameters:
      pid - the PID of the instance to be deleted
      Returns:
      a service operation object
      Throws:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs creating the operator

    • read

      Map<String,Map<String,Object>> read(String factoryPid) throws org.codice.ddf.admin.configurator.ConfiguratorException
      For the given managed service factory, retrieves the full complement of configuration properties.

      This will get all the key:value pairs for each available configuration.

      Parameters:
      factoryPid - the factoryPid of the service to query
      Returns:
      the the current sets of key:value pairs, in a map keyed on configId
      Throws:
      org.codice.ddf.admin.configurator.ConfiguratorException - if any errors occur reading the state