Package kieker.monitoring.core.controller

Class StateController

java.lang.Object
kieker.monitoring.core.controller.AbstractController
kieker.monitoring.core.controller.StateController
All Implemented Interfaces:
IStateController
public final class StateController extends AbstractController implements IStateController
Since:
1.3
Author:
Andre van Hoorn, Jan Waller

  • Constructor Details

    • StateController

      protected StateController(Configuration configuration)
      Creates a new instance of this class using the given parameter.
      Parameters:
      configuration - The configuration which will be used to initialize the controller.

  • Method Details

    • init

      protected void init()
      Description copied from class: AbstractController
      This method should to the initialization work.
      Specified by:
      init in class AbstractController

    • cleanup

      protected void cleanup()
      Description copied from class: AbstractController
      This method should clean up.
      Specified by:
      cleanup in class AbstractController

    • toString

      public String toString()
      Specified by:
      toString in class AbstractController

    • terminateMonitoring

      public boolean terminateMonitoring()
      Permanently terminates monitoring.
      Specified by:
      terminateMonitoring in interface IStateController
      Returns:
      true if now terminated; false if already terminated
      See Also:

    • isMonitoringTerminated

      public boolean isMonitoringTerminated()
      Description copied from interface: IStateController
      Returns whether monitoring is permanently terminated.
      Specified by:
      isMonitoringTerminated in interface IStateController
      Returns:
      true if monitoring is permanently terminated, false if monitoring is enabled or disabled.
      See Also:

    • enableMonitoring

      public boolean enableMonitoring()
      Enables monitoring.
      Specified by:
      enableMonitoring in interface IStateController
      Returns:
      true if monitoring is enabled, false otherwise

    • disableMonitoring

      public boolean disableMonitoring()
      Disables monitoring. If monitoring is disabled, the MonitoringController simply pauses. Furthermore, probes should stop collecting new data and monitoring writers stop should stop writing existing data.
      Specified by:
      disableMonitoring in interface IStateController
      Returns:
      true if monitoring is disabled, false otherwise

    • isMonitoringEnabled

      public boolean isMonitoringEnabled()
      Description copied from interface: IStateController
      Returns whether monitoring is enabled or disabled/terminated.
      Specified by:
      isMonitoringEnabled in interface IStateController
      Returns:
      true of monitoring is enabled, false if monitoring is disabled or terminated.
      See Also:

    • getName

      public String getName()
      Description copied from interface: IStateController
      Returns the name of this controller.
      Specified by:
      getName in interface IStateController
      Returns:
      String

    • getHostname

      public String getHostname()
      Description copied from interface: IStateController
      The hostname will be part of the monitoring data and allows to distinguish observations in cases where the software system is deployed on more than one host. When you want to distinguish multiple Virtual Machines on one host, you* have to set the hostname manually in the Configuration.
      Specified by:
      getHostname in interface IStateController
      Returns:
      The hostname.

    • incExperimentId

      public int incExperimentId()
      Increments the experiment ID by 1 and returns the new value.
      Specified by:
      incExperimentId in interface IStateController
      Returns:
      experimentID

    • setExperimentId

      public void setExperimentId(int newExperimentID)
      Sets the experiment ID to the given value.
      Specified by:
      setExperimentId in interface IStateController
      Parameters:
      newExperimentID - The new ID.

    • getExperimentId

      public int getExperimentId()
      Specified by:
      getExperimentId in interface IStateController
      Returns:
      The experiment ID.

    • isDebug

      public boolean isDebug()
      Description copied from interface: IStateController
      Is the debug mode enabled?

      Debug mode is for internal use only and changes a few internal id generation mechanisms to enable easier debugging. Additionally, it is possible to enable debug logging in the settings of the used logger.

      Specified by:
      isDebug in interface IStateController
      Returns:
      debug mode

    • setStateListener

      public void setStateListener(IStateListener stateListener)

    • getApplicationName

      public String getApplicationName()