Interface SchedulableJob

  • All Known Subinterfaces:
    ConfigGeneratingJob, ConfigValidatingJob, InterruptableContextJob, InterruptableJob

    public interface SchedulableJob
    This is the single interface which must be implemented to make a class an Obsidian job which can be scheduled and executed.

    A single execute(Context) method is where all job logic is implemented, and it should only return when all job activity is complete. This is important if a job starts a thread pool or uses asynchronous processing.

    Implementations can use the Configuration annotation to define parameters that a job collects and/or requires. The Description annotation can be used to supply useful information about the job which is shown in the web app configuration screen.

    • Method Detail

      • execute

        void execute​(Context context)
              throws java.lang.Exception
        Execute the job. This method should only return when all job activity is complete. This is important if a job starts a thread pool or uses asynchronous processing.
        Parameters:
        context - contains job configuration, execution information, etc.
        Throws:
        java.lang.Exception - any type of job failure which should mark the job Failed