org.ow2.jasmine.probe
Interface JasmineProbeManager

public interface JasmineProbeManager

Interface for JASMINe Probe Manager.

Author:

durieuxp

Method Summary

void	addProbeListener(JasmineProbeListener listener) Register a ProbeListener in order to be notified by probe state changes.
void	changeIndicator(JasmineIndicator indic) Change an indicator.
void	changeOutput(JasmineOutput output) Change an output.
void	changeProbe(JasmineProbe probe) Change a Probe with new parameters
void	changeTarget(JasmineTarget target) Change a target.
String	createIndicator(JasmineIndicator indic) Create a new Indicator
String	createOutput(JasmineOutput output) Create a new Output
String	createProbe(JasmineProbe probe) Create a new probe defined by its data
String	createTarget(JasmineTarget target) Create a new target
Collection<JasminePropertyInfo>	getIndicatorPropertyInfos(String type) get the list of possible properties for Indicator, depending of its type.
Collection<JasmineIndicator>	getIndicators() get the list of all defined indicators.
Collection<JasminePropertyInfo>	getOutputPropertyInfos(String type) get the list of possible properties for Output, depending of its type.
Collection<JasmineOutput>	getOutputs() get the list of all defined outputs.
Collection<JasmineProbe>	getProbes()
Collection<JasmineTarget>	getTargets() get the list of all defined targets.
void	loadConfig(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(String name) remove an indicator
void	removeOutput(String name) remove an output.
void	removeProbe(String id) Remove a probe.
void	removeTarget(String name) remove a target
void	saveConfig(String path) Save the current configuration in the specified xml file
void	startAllProbes() Start all the managed probes.
void	startProbe(String id) Start a probe.
void	stopAllProbes() Stop all the managed probes.
void	stopProbe(String id) Stop a probe.

Method Detail

createProbe

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

changeProbe

void changeProbe(JasmineProbe probe)
                 throws JasmineProbeException

Change a Probe with new parameters

Parameters:

probe - probe description

Throws:

JasmineProbeException

removeProbe

void removeProbe(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

getProbes

Collection<JasmineProbe> getProbes()

Returns:

all the probe definitions

startProbe

void startProbe(String id)
                throws JasmineProbeException

Start a probe.

Parameters:

id - probe identifier.

Throws:

JasmineProbeException - the probe could not be started.

stopProbe

void stopProbe(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

createOutput

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

changeOutput

void changeOutput(JasmineOutput output)
                  throws JasmineProbeException

Change 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:

output - output description

Throws:

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

removeOutput

void removeOutput(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.

getOutputs

Collection<JasmineOutput> getOutputs()

get the list of all defined outputs.

Returns:

List of the outputs

getOutputPropertyInfos

Collection<JasminePropertyInfo> getOutputPropertyInfos(String type)

get the list of possible properties for Output, depending of its type.

Parameters:

type - type of the Output (console, file, ...)

Returns:

Collection of JasminePropertyInfo

createIndicator

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

changeIndicator

void changeIndicator(JasmineIndicator indic)
                     throws JasmineProbeException

Change an indicator. It must exist, otherwise an exception is thrown. The indicator must not be used by a probe, otherwise an exception is thrown.

Parameters:

indic - indicator description

Throws:

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

removeIndicator

void removeIndicator(String name)
                     throws JasmineProbeException

remove an indicator

Parameters:

name - ident of the indicator to remove

Throws:

JasmineProbeException

getIndicators

Collection<JasmineIndicator> getIndicators()

get the list of all defined indicators.

Returns:

List of the indicators

getIndicatorPropertyInfos

Collection<JasminePropertyInfo> getIndicatorPropertyInfos(String type)

get the list of possible properties for Indicator, depending of its type.

Parameters:

type - type of the Indicator (Jmx, Lewys, ...)

Returns:

Collection of JasminePropertyInfo

createTarget

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

changeTarget

void changeTarget(JasmineTarget target)
                  throws JasmineProbeException

Change a target. It must exist, otherwise an exception is thrown.

Parameters:

target - new target description

Throws:

JasmineProbeException - is thrown if the target does not exist.

removeTarget

void removeTarget(String name)
                  throws JasmineProbeException

remove a target

Parameters:

name - ident of the target to remove

Throws:

JasmineProbeException

getTargets

Collection<JasmineTarget> getTargets()

get the list of all defined targets.

Returns:

List of the targets

addProbeListener

void addProbeListener(JasmineProbeListener listener)

Register a ProbeListener in order to be notified by probe state changes. Maybe other events will be considered...

Parameters:

listener - object that treats the probe state change

saveConfig

void saveConfig(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(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