org.ow2.jasmine.probe
Interface JProbeManagerMXBean

All Known Subinterfaces:

JasmineProbeManager

public interface JProbeManagerMXBean

MXBean for JASMINe Probe Manager. MXBean interface can be in a different package than implementation, and the implementation may have a different name.

Author:

durieuxp

Method Summary

java.lang.String	createIndicator(JasmineIndicator indic) Create a new Indicator
java.lang.String	createOutput(JasmineOutput output) Create a new Output
java.lang.String	createProbe(JasmineProbe probe) Create a new probe defined by its data
java.lang.String	createTarget(JasmineTarget target) Create a new target
JasmineIndicator	getIndicator(java.lang.String id) Get an indicator by its name
java.util.Set<java.lang.String>	getIndicatorTypes()
JasmineOutput	getOutput(java.lang.String id) Get an Output by its name
java.util.Set<java.lang.String>	getOutputTypes()
JasmineProbe	getProbe(java.lang.String id) Get a Probe by its name
JasmineTarget	getTarget(java.lang.String id) Get a Target by its name
java.lang.String[]	listIndicators() Get the list of indicators
java.lang.String[]	listOutputs() Get the list of outputs
java.lang.String[]	listProbes() Get the list of probes
java.lang.String[]	listTargets() Get the list of targets
void	loadConfig(java.lang.String path) Load the specified xml configuration file The configuration will be merged with the current one.
void	removeAllProbes() Remove all the managed probes.
void	removeIndicator(java.lang.String name) remove an indicator
void	removeOutput(java.lang.String name) remove an output.
void	removeProbe(java.lang.String id) Remove a probe.
void	removeTarget(java.lang.String name) remove a target
void	saveConfig(java.lang.String path) Save the current configuration in the specified xml file
void	startAllProbes() Start all the managed probes.
void	startProbe(java.lang.String id) Start a probe.
void	stopAllProbes() Stop all the managed probes.
void	stopProbe(java.lang.String id) Stop a probe.

Method Detail

createIndicator

java.lang.String createIndicator(JasmineIndicator indic)
                                 throws JasmineProbeException

Create a new Indicator

Parameters:

indic - indicator description

Returns:

the Id to be used to reference this indicator later.

Throws:

JasmineProbeException

listIndicators

java.lang.String[] listIndicators()
                                  throws JasmineProbeException

Get the list of indicators

Throws:

JasmineProbeException

getIndicator

JasmineIndicator getIndicator(java.lang.String id)
                              throws JasmineProbeException

Get an indicator by its name

Parameters:

id - indicator identifier.

Returns:

the Indicator definition

Throws:

JasmineProbeException

removeIndicator

void removeIndicator(java.lang.String name)
                     throws JasmineProbeException

remove an indicator

Parameters:

name - ident of the indicator to remove

Throws:

JasmineProbeException

getIndicatorTypes

java.util.Set<java.lang.String> getIndicatorTypes()

Returns:

the available indicator types.

createTarget

java.lang.String createTarget(JasmineTarget target)
                              throws JasmineProbeException

Create a new target

Parameters:

target - target description

Returns:

the Id to be used to reference this target later.

Throws:

JasmineProbeException

listTargets

java.lang.String[] listTargets()
                               throws JasmineProbeException

Get the list of targets

Throws:

JasmineProbeException

getTarget

JasmineTarget getTarget(java.lang.String id)
                        throws JasmineProbeException

Get a Target by its name

Parameters:

id - target identifier.

Returns:

the Target definition

Throws:

JasmineProbeException

removeTarget

void removeTarget(java.lang.String name)
                  throws JasmineProbeException

remove a target

Parameters:

name - ident of the target to remove

Throws:

JasmineProbeException

createOutput

java.lang.String createOutput(JasmineOutput output)
                              throws JasmineProbeException

Create a new Output

Parameters:

output - output description

Returns:

the Id to be used to reference this output later.

Throws:

JasmineProbeException

listOutputs

java.lang.String[] listOutputs()
                               throws JasmineProbeException

Get the list of outputs

Throws:

JasmineProbeException

getOutput

JasmineOutput getOutput(java.lang.String id)
                        throws JasmineProbeException

Get an Output by its name

Parameters:

id - output identifier.

Returns:

the Output definition

Throws:

JasmineProbeException

removeOutput

void removeOutput(java.lang.String name)
                  throws JasmineProbeException

remove an output. The output must exist, otherwise an exception is thrown. The output must not be used by a probe, otherwise an exception is thrown.

Parameters:

name - ident of the output to remove

Throws:

JasmineProbeException - is thrown if the output does not exist, or if it is used by a running probe.

getOutputTypes

java.util.Set<java.lang.String> getOutputTypes()

Returns:

the available output types.

createProbe

java.lang.String createProbe(JasmineProbe probe)
                             throws JasmineProbeException

Create a new probe defined by its data

Parameters:

probe - probe description

Returns:

the Id to be used to reference this probe later.

Throws:

JasmineProbeException

startProbe

void startProbe(java.lang.String id)
                throws JasmineProbeException

Start a probe.

Parameters:

id - probe identifier.

Throws:

JasmineProbeException - the probe could not be started.

stopProbe

void stopProbe(java.lang.String id)
               throws JasmineProbeException

Stop a probe.

Parameters:

id - probe identifier.

Throws:

JasmineProbeException - the probe could not be stopped.

startAllProbes

void startAllProbes()
                    throws JasmineProbeException

Start all the managed probes.

Throws:

JasmineProbeException

stopAllProbes

void stopAllProbes()
                   throws JasmineProbeException

Stop all the managed probes.

Throws:

JasmineProbeException

removeProbe

void removeProbe(java.lang.String id)
                 throws JasmineProbeException

Remove a probe.

Parameters:

id - probe identifier.

Throws:

JasmineProbeException

removeAllProbes

void removeAllProbes()
                     throws JasmineProbeException

Remove all the managed probes.

Throws:

JasmineProbeException

listProbes

java.lang.String[] listProbes()
                              throws JasmineProbeException

Get the list of probes

Throws:

JasmineProbeException

getProbe

JasmineProbe getProbe(java.lang.String id)
                      throws JasmineProbeException

Get a Probe by its name

Parameters:

id - probe identifier.

Returns:

the Probe definition

Throws:

JasmineProbeException

saveConfig

void saveConfig(java.lang.String path)
                throws JasmineProbeException

Save the current configuration in the specified xml file

Parameters:

path - the xml file, or null if saved in the default configuration file.

Throws:

JasmineProbeException

loadConfig

void loadConfig(java.lang.String path)
                throws JasmineProbeException

Load the specified xml configuration file The configuration will be merged with the current one.

Parameters:

path - the xml file, or null if load the default configuration file.

Throws:

JasmineProbeException