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

Interface FeatureActions

public interface FeatureActions
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
    boolean
    isFeatureStarted(String featureName)
    Determines if the feature with the given name is started.
    org.codice.ddf.admin.configurator.Operation<Void>
    start(String featureName)
    Creates a handler that will start a feature as part of a transaction.
    org.codice.ddf.admin.configurator.Operation<Void>
    stop(String featureName)
    Creates a handler that will stop a feature as part of a transaction.

  • Method Details

    • start

      org.codice.ddf.admin.configurator.Operation<Void> start(String featureName) throws org.codice.ddf.admin.configurator.ConfiguratorException
      Creates a handler that will start a feature as part of a transaction.
      Parameters:
      featureName - the name of the feature to start
      Returns:
      instance of this class
      Throws:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs creating the operator

    • stop

      org.codice.ddf.admin.configurator.Operation<Void> stop(String featureName) throws org.codice.ddf.admin.configurator.ConfiguratorException
      Creates a handler that will stop a feature as part of a transaction.
      Parameters:
      featureName - the name of the feature to stop
      Returns:
      instance of this class
      Throws:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs creating the operator

    • isFeatureStarted

      boolean isFeatureStarted(String featureName) throws org.codice.ddf.admin.configurator.ConfiguratorException
      Determines if the feature with the given name is started.
      Parameters:
      featureName - the name of the feature
      Returns:
      true if started; else, false
      Throws:
      org.codice.ddf.admin.configurator.ConfiguratorException - if an error occurs reading state