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

Interface BundleActions

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

  • Method Details

    • start

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

    • isStarted

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