com.onyxscheduler.web.JobController.java Source code

Introduction

Here is the source code for com.onyxscheduler.web.JobController.java

Source

/*
 * Copyright (C) 2015
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.onyxscheduler.web;

import com.onyxscheduler.domain.Job;
import com.onyxscheduler.domain.JobKey;
import com.onyxscheduler.domain.Scheduler;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;

import java.io.IOException;
import java.net.URI;
import java.util.Set;

import javax.servlet.http.HttpServletResponse;

/**
 * Main entry point for the onyx REST API (and job scheduling and managing). <p/> Here are hosted
 * all logic and configuration related to the API from documentation to mapping to proper requests,
 * responses, exception handling, etc.
 */
@RestController
@RequestMapping("/onyx")
public class JobController {

    private final Scheduler scheduler;

    @Autowired
    public JobController(Scheduler scheduler) {
        this.scheduler = scheduler;
    }

    @RequestMapping(value = "/groups/{group}/jobs", method = RequestMethod.POST)
    public ResponseEntity<Job> addJob(@PathVariable String group, @RequestBody Job job)
            throws NonMatchingGroupsException, Scheduler.DuplicateJobKeyException {
        if (job.getGroup() != null && !job.getGroup().equals(group)) {
            //throwing an exception instead of ResponseEntity.badRequest().build() to have a proper description of the bad request
            throw new NonMatchingGroupsException(group, job.getGroup());
        }
        job.setGroup(group);
        scheduler.scheduleJob(job);
        URI location = ServletUriComponentsBuilder.fromCurrentRequest().path("/{job}").buildAndExpand(job.getName())
                .toUri();
        return ResponseEntity.created(location).body(job);
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    static class NonMatchingGroupsException extends Exception {

        public NonMatchingGroupsException(String pathGroup, String bodyGroup) {
            super("group provided in the job body should be unspecified or match the path group. "
                    + "Current group in path is '" + pathGroup + "' and in body is '" + bodyGroup + "'.");
        }
    }

    @ExceptionHandler(Scheduler.DuplicateJobKeyException.class)
    void handleBadRequests(HttpServletResponse response) throws IOException {
        response.sendError(HttpStatus.BAD_REQUEST.value());
    }

    @RequestMapping(value = "/jobs", method = RequestMethod.GET)
    public Set<JobKey> getJobKeys() {
        return scheduler.getJobKeys();
    }

    @RequestMapping(value = "/groups/{group}/jobs", method = RequestMethod.GET)
    public Set<JobKey> getJobKeysByGroup(@PathVariable String group) {
        return scheduler.getJobKeysByGroup(group);
    }

    @RequestMapping(value = "/groups/{group}/jobs/{name}", method = RequestMethod.GET)
    public ResponseEntity<Job> getJob(@PathVariable String group, @PathVariable String name) {
        //since ResponseEntity.notFound().build() returns a ResponseEntity<Void> conflicting with ResponseEntity<Job> we have to use this workaround
        return scheduler.getJob(new JobKey(group, name)).map(ResponseEntity::ok)
                .orElse(ResponseEntity.status(HttpStatus.NOT_FOUND).body(null));
    }

    @RequestMapping(value = "/groups/{group}/jobs/{name}", method = RequestMethod.DELETE)
    public ResponseEntity<Void> deleteJob(@PathVariable String group, @PathVariable String name) {
        if (!scheduler.deleteJob(new JobKey(group, name))) {
            return ResponseEntity.notFound().build();
        }
        return ResponseEntity.noContent().build();
    }

}