org.graylog.scheduler.Job Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Graylog is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Graylog. If not, see .
*/
package org.graylog.scheduler;
/**
* Interface to be implemented by job classes.
*/
public interface Job {
interface Factory {
TYPE create(JobDefinitionDto jobDefinition);
}
/**
* Called by the scheduler when a trigger fires to execute the job. It returns a {@link JobTriggerUpdate} that
* instructs the scheduler about the next trigger execution time, trigger data and others.
*
* @param ctx the job execution context
* @return the trigger update
* @throws JobExecutionException if the job execution fails
*/
JobTriggerUpdate execute(JobExecutionContext ctx) throws JobExecutionException;
}