Interface ICallBackScheduler


public interface ICallBackScheduler
This interface provides a call back mechanism for scheduler tasks. Relevant methods are invoked when different events happens in the Scheduler.  To use this class, the user needs to provide his/her implementation of this interface, then specify in the EspressManager the name of the class that implements this interface.

The following flag is included in the espressmanager.bat/sh file (for EspressReport):

    -SchedulerCallBackClass:package.class
    (where package.class is the fully qualified name of the class that implements this interface)
 

important: Also be sure to include the class that implements this interface in your classpath of the EspressManager (espressmanager.bat/sh file).

For ERES, you can specify the class file in the Administration Console.  Note that the class file MUST be in the CLASSPATH of the ERES application.

  • Method Details

    • exportSucceeded

      void exportSucceeded(ScheduleObject obj, String exportPath)
      Invoked when a schedule task export succeeded. This method is invoked once for every export associated with a task, and once before the end of the task. Thus, if a task contains two exports, the method will be invoked three times.
      Parameters:
      obj - the scheduler object that contains information about the task executed
      exportPath - if the task was an export task, this parameter is the location of the exported file.
    • exportFailed

      void exportFailed(ScheduleObject obj, String exportPath, Throwable e)
      Invoked when a schedule task export failed. This method is invoked once for every failed export associated with a task, and once before the end of the task. Thus, if a task contains two failed exports, the method will be invoked three times.
      Parameters:
      obj - the scheduler object that contains information about the task executed
      exportPath - if the task was an export task, this parameter is the location of the exported file.
      e - the Exception associated with the error, if available, otherwise null.