metron-interface/metron-rest/src/main/java/org/apache/metron/rest/controller/SensorParserConfigController.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.metron.rest.controller;

import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.apache.metron.common.configuration.SensorParserConfig;
import org.apache.metron.rest.RestException;
import org.apache.metron.rest.model.ParseMessageRequest;
import org.apache.metron.rest.service.SensorParserConfigService;
import org.json.simple.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
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.RestController;

import java.util.Map;

@RestController
@RequestMapping("/api/v1/sensor/parser/config")
public class SensorParserConfigController {

  @Autowired
  private SensorParserConfigService sensorParserConfigService;

  @ApiOperation(value = "Updates or creates a SensorParserConfig in Zookeeper")
  @ApiResponses(value = { @ApiResponse(message = "SensorParserConfig updated. Returns saved SensorParserConfig", code = 200),
          @ApiResponse(message = "SensorParserConfig created. Returns saved SensorParserConfig", code = 201) })
  @RequestMapping(value = "/{name}", method = RequestMethod.POST)
  ResponseEntity<SensorParserConfig> save(@ApiParam(name="name", value="SensorParserConfig name", required=true)@PathVariable String name,
      @ApiParam(name="sensorParserConfig", value="SensorParserConfig", required=true)@RequestBody SensorParserConfig sensorParserConfig) throws RestException {
    if (sensorParserConfigService.findOne(name) == null) {
      return new ResponseEntity<>(sensorParserConfigService.save(name, sensorParserConfig), HttpStatus.CREATED);
    } else {
      return new ResponseEntity<>(sensorParserConfigService.save(name, sensorParserConfig), HttpStatus.OK);
    }
  }

  @ApiOperation(value = "Retrieves a SensorParserConfig from Zookeeper")
  @ApiResponses(value = { @ApiResponse(message = "Returns SensorParserConfig", code = 200),
          @ApiResponse(message = "SensorParserConfig is missing", code = 404) })
  @RequestMapping(value = "/{name}", method = RequestMethod.GET)
  ResponseEntity<SensorParserConfig> findOne(@ApiParam(name="name", value="SensorParserConfig name", required=true)@PathVariable String name) throws RestException {
    SensorParserConfig sensorParserConfig = sensorParserConfigService.findOne(name);
    if (sensorParserConfig != null) {
      return new ResponseEntity<>(sensorParserConfig, HttpStatus.OK);
    }

    return new ResponseEntity<>(HttpStatus.NOT_FOUND);
  }

  @ApiOperation(value = "Retrieves all SensorParserConfigs from Zookeeper")
  @ApiResponse(message = "Returns all SensorParserConfigs", code = 200)
  @RequestMapping(method = RequestMethod.GET)
  ResponseEntity<Map<String, SensorParserConfig>> findAll() throws RestException {
    return new ResponseEntity<>(sensorParserConfigService.getAll(), HttpStatus.OK);
  }

  @ApiOperation(value = "Deletes a SensorParserConfig from Zookeeper")
  @ApiResponses(value = { @ApiResponse(message = "SensorParserConfig was deleted", code = 200),
          @ApiResponse(message = "SensorParserConfig is missing", code = 404) })
  @RequestMapping(value = "/{name}", method = RequestMethod.DELETE)
  ResponseEntity<Void> delete(@ApiParam(name="name", value="SensorParserConfig name", required=true)@PathVariable String name) throws RestException {
    if (sensorParserConfigService.delete(name)) {
      return new ResponseEntity<>(HttpStatus.OK);
    } else {
      return new ResponseEntity<>(HttpStatus.NOT_FOUND);
    }
  }

  @ApiOperation(value = "Lists the available parser classes that can be found on the classpath")
  @ApiResponse(message = "Returns a list of available parser classes", code = 200)
  @RequestMapping(value = "/list/available", method = RequestMethod.GET)
  ResponseEntity<Map<String, String>> getAvailable() throws RestException {
    return new ResponseEntity<>(sensorParserConfigService.getAvailableParsers(), HttpStatus.OK);
  }

  @ApiOperation(value = "Scans the classpath for available parser classes and reloads the cached parser class list")
  @ApiResponse(message = "Returns a list of available parser classes", code = 200)
  @RequestMapping(value = "/reload/available", method = RequestMethod.GET)
  ResponseEntity<Map<String, String>> reloadAvailable() throws RestException {
    return new ResponseEntity<>(sensorParserConfigService.reloadAvailableParsers(), HttpStatus.OK);
  }

  @ApiOperation(value = "Parses a sample message given a SensorParserConfig")
  @ApiResponse(message = "Returns parsed message", code = 200)
  @RequestMapping(value = "/parseMessage", method = RequestMethod.POST)
  ResponseEntity<JSONObject> parseMessage(@ApiParam(name="parseMessageRequest", value="Object containing a sample message and SensorParserConfig", required=true) @RequestBody ParseMessageRequest parseMessageRequest) throws RestException {
    return new ResponseEntity<>(sensorParserConfigService.parseMessage(parseMessageRequest), HttpStatus.OK);
  }
}