org.javasimon.jmx

Interface SimonManagerMXBean

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimonManagerMXBeanImpl

public interface SimonManagerMXBean
extends Serializable

Interface of Simon management bean (MXBean) representing single point of access to a particular Simon Manager.

It provides general management tasks over all Simons for a single Manager (hierarchy of Simons) plus some useful util functions.

Since:

2.0

Author:

Radovan Sninsky

Method Summary

Modifier and Type	Method and Description
void	clearManager() Clears the Manager (ignored if manager is disabled).
void	disable() Disables the Simon Manager, disable monitoring application by Simons.
void	disableSimon(String name) Disables particular Simon only.
void	enable() Enables the Simon Manager, enable monitoring application by Simons.
void	enableSimon(String name) Enables particular Simon only.
CounterSample	getCounterSample(String name) Retrieves sample data object for a particular Counter.
List<CounterSample>	getCounterSamples() Sample all Counters
List<CounterSample>	getCounterSamples(String namePattern) Sample all Counters whose name matches given pattern
CounterSample	getIncrementCounterSample(String name, String key) Samples increment in Counter values since the previous call of this method with the same key.
List<CounterSample>	getIncrementCounterSamples(String key) Increment sample all Counters.
List<CounterSample>	getIncrementCounterSamples(String namePattern, String key) Incremental sample for all Counters whose name matches given pattern.
StopwatchSample	getIncrementStopwatchSample(String name, String key) Samples increment in Stopwatch values since the previous call of this method with the same key.
List<StopwatchSample>	getIncrementStopwatchSamples(String key) Increment sample all Stopwatches.
List<StopwatchSample>	getIncrementStopwatchSamples(String namePattern, String key) Increment sample all Stopwatches whose name matches given pattern.
SimonInfo[]	getSimonInfos() Returns array containing names and types of all existing Simons ordered naturally by name.
String[]	getSimonNames() Returns array containing full hierarchical names of all existing Simons.
String[]	getSimonNamesOrdered() Returns array containing full hierarchical names of all existing Simons in natural String order.
StopwatchSample	getStopwatchSample(String name) Retrieves sample data object for a particular Stopwatch.
List<StopwatchSample>	getStopwatchSamples() Sample all Stopwatches.
List<StopwatchSample>	getStopwatchSamples(String namePattern) Sample all Stopwatches whose name matches given pattern.
String	getType(String name) Returns type of Simon, either COUNTER, STOPWATCH or UNKNOWN.
void	inheritState(String name) Lets the Simon to inherit its enable/disable state from its parent.
boolean	isEnabled() Returns true if the Simon Manager is enabled, if monitoring is enabled.
void	printSimonTree() Prints multi-line string containing Simon tree starting with the specified Simon to standard output.

Method Detail

enable

void enable()

Enables the Simon Manager, enable monitoring application by Simons.

See Also:

Manager.enable()

disable

void disable()

Disables the Simon Manager, disable monitoring application by Simons.

See Also:

Manager.disable()

isEnabled

boolean isEnabled()

Returns true if the Simon Manager is enabled, if monitoring is enabled.

Returns:

true if the Simon Manager is enabled

See Also:

Manager.isEnabled()

getSimonNames

String[] getSimonNames()

Returns array containing full hierarchical names of all existing Simons.

Returns:

array of all Simon names

See Also:

Manager.getSimonNames()

getSimonNamesOrdered

String[] getSimonNamesOrdered()

Returns array containing full hierarchical names of all existing Simons in natural String order.

Returns:

array of all Simon names (ordered)

See Also:

Manager.getSimonNames()

getType

String getType(String name)

Returns type of Simon, either COUNTER, STOPWATCH or UNKNOWN.

Parameters:

name - name of Simon

Returns:

string COUNTER if Counter Simon, STOPWATCH if Stopwatch Simon or UNKNOWN if there is no Simon just undefined hierarchy node

getSimonInfos

SimonInfo[] getSimonInfos()

Returns array containing names and types of all existing Simons ordered naturally by name.

Returns:

array of SimonInfo objects

clearManager

void clearManager()

Clears the Manager (ignored if manager is disabled). All Simons are lost, but the configuration is preserved.

See Also:

Manager.clear()

enableSimon

void enableSimon(String name)

Enables particular Simon only.

Parameters:

name - name of the Simon

See Also:

Simon.setState(org.javasimon.SimonState, boolean)

disableSimon

void disableSimon(String name)

Disables particular Simon only.

Parameters:

name - name of the Simon

See Also:

Simon.setState(org.javasimon.SimonState, boolean)

inheritState

void inheritState(String name)

Lets the Simon to inherit its enable/disable state from its parent.

Parameters:

name - name of the Simon

getCounterSample

CounterSample getCounterSample(String name)

Retrieves sample data object for a particular Counter.

Parameters:

name - name of the Simon

Returns:

sample object or null if Simon with entered name doesn't exist

See Also:

CounterSample

getStopwatchSample

StopwatchSample getStopwatchSample(String name)

Retrieves sample data object for a particular Stopwatch.

Parameters:

name - name of the Simon

Returns:

sample object or null if Simon with entered name doesn't exist

See Also:

StopwatchSample

getIncrementCounterSample

CounterSample getIncrementCounterSample(String name,
                                        String key)

Samples increment in Counter values since the previous call of this method with the same key. When the method is called the first time for the key, current values are returned (same like from getCounterSample(String) }. Any subsequent calls with the key provide increments.

Clients should use a unique key (GUID, host name, etc.), to avoid interference with other clients.

Parameters:

name - name of the stopwatch

key - name of an incremental sample

Returns:

sample collected for a specified key if it was created before

getIncrementStopwatchSample

StopwatchSample getIncrementStopwatchSample(String name,
                                            String key)

Samples increment in Stopwatch values since the previous call of this method with the same key. When the method is called the first time for the key, current values are returned (same like from getCounterSample(String) }. Any subsequent calls with the key provide increments.

Clients should use a unique key (GUID, host name, etc.), to avoid interference with other clients.

Parameters:

name - name of the stopwatch

key - name of an incremental sample

Returns:

sample collected for a specified key if it was created before

printSimonTree

void printSimonTree()

Prints multi-line string containing Simon tree starting with the specified Simon to standard output.

See Also:

SimonUtils.simonTreeString(org.javasimon.Simon)

getCounterSamples

List<CounterSample> getCounterSamples()

Sample all Counters

Returns:

One Sample for each Counter

getIncrementCounterSamples

List<CounterSample> getIncrementCounterSamples(String key)

Increment sample all Counters.

Parameters:

key - name of an incremental sample

Returns:

one Sample for each Counter

See Also:

getIncrementCounterSample(String, String)

getCounterSamples

List<CounterSample> getCounterSamples(String namePattern)

Sample all Counters whose name matches given pattern

Parameters:

namePattern - Name pattern, null means all Counters

Returns:

One Sample for each Counter

getIncrementCounterSamples

List<CounterSample> getIncrementCounterSamples(String namePattern,
                                               String key)

Incremental sample for all Counters whose name matches given pattern. *

Parameters:

namePattern - name pattern (SimonPattern), null means all Counters

key - name of an incremental sample

Returns:

one Sample for each Counter whose name matches given pattern

See Also:

getIncrementCounterSample(String, String)

getStopwatchSamples

List<StopwatchSample> getStopwatchSamples(String namePattern)

Sample all Stopwatches whose name matches given pattern.

Parameters:

namePattern - name pattern (SimonPattern), null means all Stopwatches

Returns:

one Sample for each Stopwatch

getIncrementStopwatchSamples

List<StopwatchSample> getIncrementStopwatchSamples(String namePattern,
                                                   String key)

Increment sample all Stopwatches whose name matches given pattern.

Parameters:

namePattern - name pattern (SimonPattern), null means all Stopwatches

key - name of an incremental sample

Returns:

one Sample for each Stopwatch whose name matches given pattern

See Also:

getIncrementStopwatchSample(String, String)

getStopwatchSamples

List<StopwatchSample> getStopwatchSamples()

Sample all Stopwatches.

Returns:

one Sample for each Stopwatch

getIncrementStopwatchSamples

List<StopwatchSample> getIncrementStopwatchSamples(String key)

Increment sample all Stopwatches.

Parameters:

key - name of an incremental sample

Returns:

one Sample for each Stopwatch

See Also:

getIncrementStopwatchSample(String, String)