kieker.monitoring.core.controller
Interface IStateController

All Known Subinterfaces:

IMonitoringController

All Known Implementing Classes:

MonitoringController, StateController

public interface IStateController

Since:

1.3

Author:

Jan Waller

Method Summary

boolean	disableMonitoring() Disables monitoring.
boolean	enableMonitoring() Enables monitoring.
int	getExperimentId()
java.lang.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.
java.lang.String	getName() Returns the name of this controller.
int	incExperimentId() Increments the experiment ID by 1 and returns the new value.
boolean	isDebug() Is the debug mode enabled?
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

Since:

1.3

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.

Since:

1.3

See Also:

terminateMonitoring()

enableMonitoring

boolean enableMonitoring()

Enables monitoring.

Returns:

true if monitoring is enabled, false otherwise

Since:

1.3

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

Since:

1.3

isMonitoringEnabled

boolean isMonitoringEnabled()

Returns whether monitoring is enabled or disabled/terminated.

Returns:

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

Since:

1.3

See Also:

disableMonitoring(), enableMonitoring()

getName

java.lang.String getName()

Returns the name of this controller.

Returns:

String

Since:

1.3

getHostname

java.lang.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.

Returns:

The hostname.

Since:

1.3

incExperimentId

int incExperimentId()

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

Returns:

experimentID

Since:

1.3

setExperimentId

void setExperimentId(int newExperimentID)

Sets the experiment ID to the given value.

Parameters:

newExperimentID - The new ID.

Since:

1.3

getExperimentId

int getExperimentId()

Returns:

The experiment ID.

Since:

1.3

isDebug

boolean isDebug()

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.

Returns:

debug mode

Since:

1.6