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

void	addDefaultOutput(String id) Add an output to the default outputs list.
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	changeProbePeriod(String id, int period) Set a new value for probe period
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
JasmineIndicator	getIndicator(String id) Get an indicator by its name
Set<String>	getIndicatorCurrentUse(String name) Get the list of probes using this indicator
List<JasmineIndicator>	getIndicators() get the list of all defined indicators.
JasmineCollectorInfo	getIndicatorTypeInfo(String type) Get all infiormation about the type of indicator
Set<String>	getIndicatorTypes()
JasmineOutput	getOutput(String id) Get an Output by its name
Set<String>	getOutputCurrentUse(String name) Get the list of probes using this output
List<JasminePropertyInfo>	getOutputPropertyInfos(String type) get the list of possible properties for Output, depending of its type.
List<JasmineOutput>	getOutputs() get the list of all defined outputs.
Set<String>	getOutputTypes()
JasmineProbe	getProbe(String id) Get a Probe by its name
List<JasmineProbe>	getProbes()
JasmineTarget	getTarget(String id) Get a Target by its name
List<JasminePropertyInfo>	getTargetPropertyInfos(String type) get the list of possible properties for Target, depending of its type.
List<JasmineTarget>	getTargets() get the list of all defined targets.
Set<String>	getTargetTypes()
String[]	listDefaultOutputs() Get the list of the default outputs.
String[]	listIndicators(String type) Get the list of all indicators or of indicators of a given type
String[]	listOutputs(String type) Get the list of all outputs or of outputs having a given type
String[]	listProbes() Get the list of probes
String[]	listTargets() Get the list of 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	removeDefaultOutput(String id) Remove an output from the default outputs list.
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

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.

Parameters:

indic - indicator description

Throws:

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

listIndicators

String[] listIndicators(String type)

Get the list of all indicators or of indicators of a given type

Parameters:

type - the given type. If null, get all the indicators.

getIndicator

JasmineIndicator getIndicator(String id)
                              throws JasmineProbeException

Get an indicator by its name

Parameters:

id - indicator identifier.

Returns:

the Indicator definition

Throws:

JasmineProbeException

getIndicators

List<JasmineIndicator> getIndicators()

get the list of all defined indicators.

Returns:

List of the indicators

removeIndicator

void removeIndicator(String name)
                     throws JasmineProbeException

remove an indicator

Parameters:

name - ident of the indicator to remove

Throws:

JasmineProbeException

getIndicatorTypes

Set<String> getIndicatorTypes()

Returns:

the available indicator types.

getIndicatorTypeInfo

JasmineCollectorInfo getIndicatorTypeInfo(String type)

Get all infiormation about the type of indicator

Parameters:

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

Returns:

JasmineIndicatorTypeInfo

getIndicatorCurrentUse

Set<String> getIndicatorCurrentUse(String name)
                                   throws JasmineProbeException

Get the list of probes using this indicator

Parameters:

name - Indicator name

Returns:

list of probe ids

Throws:

JasmineProbeException - bad parameter

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.

listTargets

String[] listTargets()
                     throws JasmineProbeException

Get the list of targets

Throws:

JasmineProbeException

getTarget

JasmineTarget getTarget(String id)
                        throws JasmineProbeException

Get a Target by its name

Parameters:

id - target identifier.

Returns:

the Target definition

Throws:

JasmineProbeException

getTargets

List<JasmineTarget> getTargets()

get the list of all defined targets.

Returns:

List of the targets

removeTarget

void removeTarget(String name)
                  throws JasmineProbeException

remove a target

Parameters:

name - ident of the target to remove

Throws:

JasmineProbeException

getTargetTypes

Set<String> getTargetTypes()

Returns:

the available target types.

getTargetPropertyInfos

List<JasminePropertyInfo> getTargetPropertyInfos(String type)

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

Parameters:

type - type of the Target (today: only jmx is supported)

Returns:

List of JasminePropertyInfo

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.

Parameters:

output - output description

Throws:

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

listOutputs

String[] listOutputs(String type)

Get the list of all outputs or of outputs having a given type

Parameters:

type - the given type. If null, get all the outputs.

listDefaultOutputs

String[] listDefaultOutputs()

Get the list of the default outputs.

addDefaultOutput

void addDefaultOutput(String id)
                      throws JasmineProbeException

Add an output to the default outputs list.

Parameters:

id - output identifier

Throws:

JasmineProbeException - If there is no output with the given identifier

removeDefaultOutput

void removeDefaultOutput(String id)
                         throws JasmineProbeException

Remove an output from the default outputs list.

Parameters:

id - output identifier

Throws:

JasmineProbeException - If there is no output with the given identifier in the default outputs list.

getOutput

JasmineOutput getOutput(String id)
                        throws JasmineProbeException

Get an Output by its name

Parameters:

id - output identifier.

Returns:

the Output definition

Throws:

JasmineProbeException

getOutputs

List<JasmineOutput> getOutputs()

get the list of all defined outputs.

Returns:

List of the outputs

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.

getOutputTypes

Set<String> getOutputTypes()

Returns:

the available output types.

getOutputPropertyInfos

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

List of JasminePropertyInfo

getOutputCurrentUse

Set<String> getOutputCurrentUse(String name)
                                throws JasmineProbeException

Get the list of probes using this output

Parameters:

name - Output name

Returns:

list of probe ids

Throws:

JasmineProbeException - bad parameter

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

changeProbePeriod

void changeProbePeriod(String id,
                       int period)
                       throws JasmineProbeException

Set a new value for probe period

Parameters:

id - probe identifier.

period - in seconds

Throws:

JasmineProbeException

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

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

listProbes

String[] listProbes()
                    throws JasmineProbeException

Get the list of probes

Throws:

JasmineProbeException

getProbe

JasmineProbe getProbe(String id)
                      throws JasmineProbeException

Get a Probe by its name

Parameters:

id - probe identifier.

Returns:

the Probe definition

Throws:

JasmineProbeException

getProbes

List<JasmineProbe> getProbes()

Returns:

all the probe definitions

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