com.palantir.opensource.sysmon
Interface SystemMonitor

All Known Implementing Classes:

LinuxMonitor

public interface SystemMonitor

Interface for platform monitors.

Field Summary

static String	CONFIG_KEY_PREFIX Prefix for configuration keys found in the Properties objects passed to startPlatformSpecificMonitoring(Properties).
static String	DEFAULT_JMX_BEAN_PATH Root of Sysmon JMX beans in the bean server hierarchy.

Method Summary

void	startPlatformSpecificMonitoring(Properties config) Start monitoring for this specific platform (as implemented by instances of this interface).
void	stopPlatformSpecificMonitoring() Stop monitoring for this specific platform (as implemented by instances of this interface).
void	verifyExecutionEnvironment(Properties config) Tells the platform specific monitor to check that it believes that it is compatible with the current VM's execution environments.

Field Detail

DEFAULT_JMX_BEAN_PATH

static final String DEFAULT_JMX_BEAN_PATH

Root of Sysmon JMX beans in the bean server hierarchy. Bean root: "sysmon"

See Also:

Constant Field Values

CONFIG_KEY_PREFIX

static final String CONFIG_KEY_PREFIX

Prefix for configuration keys found in the Properties objects passed to startPlatformSpecificMonitoring(Properties). Implementations should use this constant to build up their own config prefixes so as to avoid conflicts in the configuration namespace. Config prefix: "sysmon"

See Also:

Constant Field Values

Method Detail

startPlatformSpecificMonitoring

void startPlatformSpecificMonitoring(Properties config)
                                     throws SysmonException

Start monitoring for this specific platform (as implemented by instances of this interface).

Parameters:

config - configuration information for the specific monitor implementations. Must empty and/or null Properties objects as a way of signalling that default values should be used.

Throws:

SysmonException

stopPlatformSpecificMonitoring

void stopPlatformSpecificMonitoring()

Stop monitoring for this specific platform (as implemented by instances of this interface).

verifyExecutionEnvironment

void verifyExecutionEnvironment(Properties config)
                                throws SysmonException

Tells the platform specific monitor to check that it believes that it is compatible with the current VM's execution environments. This is where the platform monitor might check versions and paths that it expects to exist.

Throws:

Exception - to specify errors with execution environment.

SysmonException