J F W

HOW TO : CORE

create a probe

The probe can be a class of any kind since no class must be extended or implemented. What the probe utilities class offers is a mechanism to save the status of an operation. This mechanism can be used to save the execution status of any operation.

Here is the code of a probe:

public final class MyProbe extends ScheduleBean { public void start() throws Throwable { //the logical name of the probe String probeName = "my probe"; boolean isOk = true; //you can add here a check code that will change //the value of attribute isOk //save status of probe if(isOk) { ProbeStatus.getInstance().setStatus(probeName, ProbeStatus.STATUS_OK); } else { ProbeStatus.getInstance().setStatus(probeName, ProbeStatus.STATUS_KO); addError("something bad happen"); ProbeUtil.sendEmail("my_probe_sender", "my_probe_receivers", "my_probe_object", "my_probe_text", null); } } }

In this example, the probe mechanism has been added to a scheduled class.
We have to define a unique probe name (String probeName = "my probe";) and to set the execution result using the method setStatus of class ProbeStatus.
If an error occurs, or if the probe fails, we can send an email using the method sendEmail of class ProbeUtil.