kieker.monitoring.core.controller
Interface IStateController

All Known Subinterfaces:

IMonitoringController, MonitoringControllerMBean

All Known Implementing Classes:

MonitoringController, StateController

public interface IStateController

Author:

Jan Waller

Method Summary

boolean	disableMonitoring() Disables monitoring.
boolean	enableMonitoring() Enables monitoring.
int	getExperimentId() Returns the experiment ID.
String	getHostName() 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.
String	getName() Returns the name of this controller.
int	incExperimentId() Increments the experiment ID by 1 and returns the new value.
boolean	isMonitoringEnabled() Returns whether monitoring is enabled or disabled/terminated.
boolean	isMonitoringTerminated() Returns whether monitoring is permanently terminated.
void	setExperimentId(int newExperimentID) Sets the experiment ID to the given value.
boolean	terminateMonitoring() Permanently terminates monitoring

Method Detail

terminateMonitoring

boolean terminateMonitoring()

Permanently terminates monitoring

Returns:

true if now terminated; false if already terminated

See Also:

isMonitoringTerminated()

isMonitoringTerminated

boolean isMonitoringTerminated()

Returns whether monitoring is permanently terminated.

Returns:

true if monitoring is permanently terminated, false if monitoring is enabled or disabled.

See Also:

terminateMonitoring()

enableMonitoring

boolean enableMonitoring()

Enables monitoring.

Returns:

true if monitoring is enabled, false otherwise

disableMonitoring

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.

Returns:

true if monitoring is disabled, false otherwise

isMonitoringEnabled

boolean isMonitoringEnabled()

Returns whether monitoring is enabled or disabled/terminated.

Returns:

true of monitoring is enabled, false if monitoring is disabled or terminated.

See Also:

disableMonitoring(), enableMonitoring()

getName

String getName()

Returns the name of this controller.

Returns:

String

getHostName

String getHostName()

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.

incExperimentId

int incExperimentId()

Increments the experiment ID by 1 and returns the new value.

Returns:

experimentID

setExperimentId

void setExperimentId(int newExperimentID)

Sets the experiment ID to the given value.

Parameters:

newExperimentID -

getExperimentId

int getExperimentId()

Returns the experiment ID.

Returns:

experimentID