Package org.graylog.scheduler.rest

Class JobResourceHandlerService

java.lang.Object

org.graylog.scheduler.rest.JobResourceHandlerService

public class JobResourceHandlerService
extends Object

JobResourceHandlers provide a pluggable way to list and cancel Jobs that run within the new JobScheduler. The main reason why this is currently not a generic solution, is that each Job implementation needs to perform their own permission checks. That's why every call contains the current UserContext. Another responsibility is converting JobTriggerDto to SystemJobSummary objects, to cater the existing system job endpoints. We might change this in the future, once we have a better idea on how to build a more generic job API.

Constructor Summary

Constructors

Constructor	Description
JobResourceHandlerService(Map<String,JobResourceHandler> resourceHandlers)

Method Summary

Modifier and Type	Method	Description
int	acknowledgeJob(UserContext userContext, String jobId)
Optional<JobTriggerDto>	cancelJob(UserContext userContext, String jobId)
Optional<SystemJobSummary>	cancelJobWithSystemJobSummary(UserContext userContext, String jobId)
Optional<JobTriggerDto>	getJob(UserContext userContext, String jobId)
Optional<SystemJobSummary>	getJobAsSystemJobSummery(UserContext userContext, String jobId)
SystemJobSummary	jobSummaryFromTrigger(JobTriggerDto trigger)
List<JobTriggerDto>	listJobs(UserContext userContext)
List<SystemJobSummary>	listJobsAsSystemJobSummary(UserContext userContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JobResourceHandlerService

@Inject
public JobResourceHandlerService(Map<String,JobResourceHandler> resourceHandlers)

Method Details

listJobs

public List<JobTriggerDto> listJobs(UserContext userContext)

listJobsAsSystemJobSummary

public List<SystemJobSummary> listJobsAsSystemJobSummary(UserContext userContext)

getJob

public Optional<JobTriggerDto> getJob(UserContext userContext,
 String jobId)

getJobAsSystemJobSummery

public Optional<SystemJobSummary> getJobAsSystemJobSummery(UserContext userContext,
 String jobId)

cancelJob

public Optional<JobTriggerDto> cancelJob(UserContext userContext,
 String jobId)

cancelJobWithSystemJobSummary

public Optional<SystemJobSummary> cancelJobWithSystemJobSummary(UserContext userContext,
 String jobId)

acknowledgeJob

public int acknowledgeJob(UserContext userContext,
 String jobId)

jobSummaryFromTrigger

public SystemJobSummary jobSummaryFromTrigger(JobTriggerDto trigger)