com.businessobjects.sdk.monitoring.plugin.desktop.probe
Interface IProbeInfoObjectBase

All Known Subinterfaces:

IProbeInfoObject

public interface IProbeInfoObjectBase

This is the base interface for probe InfoObject.

Method Summary

long	getHealthProbeExecTime() This method is used to retrieve the last execution time of the Health Probe.
java.util.Map	getInputParameters() This method is used to retrieve the input parameters stored in the InfoObject.
java.util.Map	getInputProperties() This method is used to retrieve the map of input properties stored in the InfoObject.
boolean	getIsConfigurable() This method is used to retrieve the input parameters of the probe that are configurable.
java.lang.String	getProbeClassName() This method is used to retrieve the class name of the probe.
long	getProbeExecTime() This method is used to retrieve the probe execution time in seconds.
java.lang.String	getProbeResult() This method is used to retrieve the probe result.
long	getTimeout() This method is used to retrieve the timeout in seconds.
java.lang.String	getType() This method is used to retrieve the type of the probe.
IVirtualMetrics	getVirtualMetrics() This method is used to retrieve the Virtual Metrics.
int	getVMetricsValidity() This method is used to retrieve the value in minutes which represents the validity of the Virtual Metrics.
void	setHealthProbeExecTime() This method is used to set the current time in SI_HEALTHPROBE_EXECTIME.
void	setInputParameters(java.util.Map inputParam) This method is used to set the input parameters.
void	setInputProperties(java.util.Map inputProps) This method is used to set the input properties in the InfoObject.
void	setInputPropertyBag(PropertyBag bag) This method is used to set the input properties on probe InfoObject.
void	setIntialized(boolean isInit) This method is used to set the initialized flag.
void	setIsConfigurable(boolean isConfigurable) This method is used to set the isConfigurable property of the probe.
void	setProbeClassName(java.lang.String className) This method is used to set the class name of the probe.
void	setProbeExecTime(long seconds) This method is used to set the probe execution time in seconds.
void	setProbeResult(java.lang.String result) This method is used to set the probe result.
void	setTimeout(long seconds) This method is used to set the timeout in seconds.
void	setType(java.lang.String type) This method is used to set the type of the probe.
void	setVirtualMetrics(java.util.Map vMetrics) This method is used to set the Virtual Metrics.
void	setVMetricsValidity(int minutes) This method is used to set the Virtual Metrics validity in minutes.

Method Detail

getInputParameters

java.util.Map getInputParameters()
                                 throws SDKException

This method is used to retrieve the input parameters stored in the InfoObject.

Returns:

Map of input parameters stored in the InfoObject

Throws:

SDKException - An SDKException

setInputParameters

void setInputParameters(java.util.Map inputParam)
                        throws SDKException

This method is used to set the input parameters.

Parameters:

inputParam - Input parameters

Throws:

SDKException - An SDKException

getProbeClassName

java.lang.String getProbeClassName()
                                   throws SDKException

This method is used to retrieve the class name of the probe.

Returns:

Class name of the probe

Throws:

SDKException - An SDKException

setProbeClassName

void setProbeClassName(java.lang.String className)
                       throws SDKException

This method is used to set the class name of the probe.

Parameters:

className - Class name of the probe implementation.

Throws:

SDKException - An SDKException

getTimeout

long getTimeout()
                throws SDKException

This method is used to retrieve the timeout in seconds.

Returns:

Timeout in seconds.

Throws:

SDKException - An SDKException

setTimeout

void setTimeout(long seconds)
                throws SDKException

This method is used to set the timeout in seconds.

Parameters:

seconds - Timeout interval in seconds

Throws:

SDKException - An SDKException

setProbeResult

void setProbeResult(java.lang.String result)
                    throws SDKException

This method is used to set the probe result. The probe result can be Success or Failed or TimedOut.

Parameters:

result - Probe Result

Throws:

SDKException - An SDKException

getProbeResult

java.lang.String getProbeResult()
                                throws SDKException

This method is used to retrieve the probe result.

Returns:

Probe Result Success or Failed or TimedOut

Throws:

SDKException - An SDKException

setProbeExecTime

void setProbeExecTime(long seconds)
                      throws SDKException

This method is used to set the probe execution time in seconds.

Parameters:

seconds - execution time in seconds

Throws:

SDKException - An SDKException

getProbeExecTime

long getProbeExecTime()
                      throws SDKException

This method is used to retrieve the probe execution time in seconds.

Returns:

Execution time in seconds

Throws:

SDKException - An SDKException

getVirtualMetrics

IVirtualMetrics getVirtualMetrics()

This method is used to retrieve the Virtual Metrics. Returns null when there is no Virtual Metrics.

Returns:

IVirtualMetrics

setVirtualMetrics

void setVirtualMetrics(java.util.Map vMetrics)
                       throws SDKException

This method is used to set the Virtual Metrics.

Parameters:

vMetrics - Virtual Metrics

Throws:

SDKException - PropertyNotFound

setHealthProbeExecTime

void setHealthProbeExecTime()

This method is used to set the current time in SI_HEALTHPROBE_EXECTIME.

getVMetricsValidity

int getVMetricsValidity()

This method is used to retrieve the value in minutes which represents the validity of the Virtual Metrics. This value is used with SI_HEALTHPROBE_EXECTIME to determine whether the probe has to be executed on request. Returns 0 if the property is not found.

Returns:

Virtual Metrics validity in minutes.

setVMetricsValidity

void setVMetricsValidity(int minutes)

This method is used to set the Virtual Metrics validity in minutes.

Parameters:

minutes - Virtual Metrics validity in minutes

getHealthProbeExecTime

long getHealthProbeExecTime()

This method is used to retrieve the last execution time of the Health Probe. Returns 0 if the property is not found.

Returns:

Time of the last execution.

getInputProperties

java.util.Map getInputProperties()
                                 throws SDKException

This method is used to retrieve the map of input properties stored in the InfoObject.

Returns:

Map of input properties stored in the InfoObject

Throws:

SDKException - An SDKException

setInputProperties

void setInputProperties(java.util.Map inputProps)
                        throws SDKException

This method is used to set the input properties in the InfoObject.

Parameters:

inputProps - Map of input properties to be stored in the InfoObject

Throws:

SDKException - An SDKException

setInputPropertyBag

void setInputPropertyBag(PropertyBag bag)

This method is used to set the input properties on probe InfoObject.

Parameters:

bag - PropertyBag

setIntialized

void setIntialized(boolean isInit)

This method is used to set the initialized flag.

Parameters:

isInit - isIntialized

getType

java.lang.String getType()

This method is used to retrieve the type of the probe.

Returns:

Type of the probe

setType

void setType(java.lang.String type)

This method is used to set the type of the probe.

Parameters:

type - type of the probe

getIsConfigurable

boolean getIsConfigurable()

This method is used to retrieve the input parameters of the probe that are configurable.

Returns:

isConfigurable of the probe

setIsConfigurable

void setIsConfigurable(boolean isConfigurable)

This method is used to set the isConfigurable property of the probe.

Parameters:

isConfigurable - is the probe configurable