org.graylog.scheduler.rest.JobResourceHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation

Graylog

There is a newer version: 6.1.4

/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.scheduler.rest;

import com.google.common.collect.ImmutableList;
import org.graylog.scheduler.JobTriggerDto;
import org.graylog.security.UserContext;

import java.util.List;
import java.util.Optional;

/**
 * Pluggable interface for common job scheduler resource tasks.
 * Implementations are responsible on checking the permissions of the {@link UserContext}
 */
public interface JobResourceHandler {

    default List listAllJobs(UserContext userContext) {
        return ImmutableList.of();
    }

    default Optional getJob(UserContext userContext, String jobID) {
        return Optional.empty();
    }

    default Optional cancelJob(UserContext userContext, String jobId) {
        return Optional.empty();
    }

    default int acknowledgeJob(UserContext userContext, String jobId) {
        return 0;
    }

    default JobTriggerDetails getTriggerDetails(JobTriggerDto triggerDto) {
        return JobTriggerDetails.EMPTY_DETAILS;
    }
}