import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import io.swagger.annotations.ApiResponse;
-import io.swagger.annotations.ApiResponses;
-
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+
+import java.lang.invoke.MethodHandles;
import java.util.ArrayList;
import java.util.List;
-import org.everit.json.schema.Schema;
-import org.everit.json.schema.loader.SchemaLoader;
import org.json.JSONObject;
-import org.oransc.enrichment.clients.ProducerCallbacks;
import org.oransc.enrichment.configuration.ApplicationConfig;
import org.oransc.enrichment.controllers.ErrorResponse;
import org.oransc.enrichment.controllers.VoidResponse;
+import org.oransc.enrichment.controllers.producer.ProducerCallbacks;
import org.oransc.enrichment.exceptions.ServiceException;
import org.oransc.enrichment.repository.EiJob;
import org.oransc.enrichment.repository.EiJobs;
+import org.oransc.enrichment.repository.EiProducers;
import org.oransc.enrichment.repository.EiType;
import org.oransc.enrichment.repository.EiTypes;
-import org.oransc.enrichment.repository.ImmutableEiJob;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import reactor.core.publisher.Mono;
@SuppressWarnings("java:S3457") // No need to call "toString()" method as formatting and string ..
-@RestController("ConsumerController")
-@Api(tags = {ConsumerConsts.CONSUMER_API_NAME})
+@RestController("A1-EI")
+@Tag(name = ConsumerConsts.CONSUMER_API_NAME)
@RequestMapping(path = ConsumerConsts.API_ROOT, produces = MediaType.APPLICATION_JSON_VALUE)
public class ConsumerController {
+ private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+
@Autowired
ApplicationConfig applicationConfig;
@Autowired
private EiTypes eiTypes;
+ @Autowired
+ private EiProducers eiProducers;
+
@Autowired
ProducerCallbacks producerCallbacks;
- private static Gson gson = new GsonBuilder() //
- .create(); //
+ private static Gson gson = new GsonBuilder().create();
@GetMapping(path = "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI type identifiers", notes = "")
+ @Operation(summary = "EI type identifiers", description = "")
@ApiResponses(
value = { //
@ApiResponse(
- code = 200,
- message = "EI type identifiers",
- response = String.class,
- responseContainer = "List"), //
+ responseCode = "200",
+ description = "EI type identifiers", //
+ content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))), //
})
public ResponseEntity<Object> getEiTypeIdentifiers( //
) {
}
@GetMapping(path = "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI type", notes = "")
+ @Operation(summary = "Individual EI type", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI type", response = ConsumerEiTypeInfo.class), //
@ApiResponse(
- code = 404,
- message = "Enrichment Information type is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "200",
+ description = "EI type", //
+ content = @Content(schema = @Schema(implementation = ConsumerEiTypeInfo.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information type is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public ResponseEntity<Object> getEiType( //
@PathVariable("eiTypeId") String eiTypeId) {
try {
}
@GetMapping(path = "/eijobs", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI job identifiers", notes = "query for EI job identifiers")
+ @Operation(summary = "EI job identifiers", description = "query for EI job identifiers")
@ApiResponses(
value = { //
@ApiResponse(
- code = 200,
- message = "EI job identifiers",
- response = String.class,
- responseContainer = "List"), //
+ responseCode = "200",
+ description = "EI job identifiers", //
+ content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))),
@ApiResponse(
- code = 404,
- message = "Enrichment Information type is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "404",
+ description = "Enrichment Information type is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public ResponseEntity<Object> getEiJobIds( //
- @ApiParam(
+ @Parameter(
name = ConsumerConsts.EI_TYPE_ID_PARAM,
required = false, //
- value = ConsumerConsts.EI_TYPE_ID_PARAM_DESCRIPTION) //
+ description = ConsumerConsts.EI_TYPE_ID_PARAM_DESCRIPTION) //
@RequestParam(name = ConsumerConsts.EI_TYPE_ID_PARAM, required = false) String eiTypeId,
- @ApiParam(
+ @Parameter(
name = ConsumerConsts.OWNER_PARAM,
required = false, //
- value = ConsumerConsts.OWNER_PARAM_DESCRIPTION) //
+ description = ConsumerConsts.OWNER_PARAM_DESCRIPTION) //
@RequestParam(name = ConsumerConsts.OWNER_PARAM, required = false) String owner) {
try {
List<String> result = new ArrayList<>();
if (owner != null) {
for (EiJob job : this.eiJobs.getJobsForOwner(owner)) {
- if (eiTypeId == null || job.type().getId().equals(eiTypeId)) {
- result.add(job.id());
+ if (eiTypeId == null || job.getTypeId().equals(eiTypeId)) {
+ result.add(job.getId());
}
}
} else if (eiTypeId != null) {
- this.eiJobs.getJobsForType(eiTypeId).forEach(job -> result.add(job.id()));
+ this.eiJobs.getJobsForType(eiTypeId).forEach(job -> result.add(job.getId()));
} else {
- this.eiJobs.getJobs().forEach(job -> result.add(job.id()));
+ this.eiJobs.getJobs().forEach(job -> result.add(job.getId()));
}
return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
} catch (
}
}
- @GetMapping(path = "/eijobs/{eiJobId}", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI job", notes = "")
+ @GetMapping(path = "/eijobs/{eiJobId}", produces = MediaType.APPLICATION_JSON_VALUE) //
+ @Operation(summary = "Individual EI job", description = "") //
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI job", response = ConsumerEiJobInfo.class), //
@ApiResponse(
- code = 404,
- message = "Enrichment Information job is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "200",
+ description = "EI job", //
+ content = @Content(schema = @Schema(implementation = ConsumerEiJobInfo.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information job is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public ResponseEntity<Object> getIndividualEiJob( //
@PathVariable("eiJobId") String eiJobId) {
try {
}
@GetMapping(path = "/eijobs/{eiJobId}/status", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI job status", notes = "")
+ @Operation(summary = "EI job status", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI job status", response = ConsumerEiJobStatus.class), //
@ApiResponse(
- code = 404,
- message = "Enrichment Information job is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "200",
+ description = "EI job status", //
+ content = @Content(schema = @Schema(implementation = ConsumerEiJobStatus.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information job is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public ResponseEntity<Object> getEiJobStatus( //
@PathVariable("eiJobId") String eiJobId) {
try {
}
private ConsumerEiJobStatus toEiJobStatus(EiJob job) {
- // TODO
- return new ConsumerEiJobStatus(ConsumerEiJobStatus.EiJobStatusValues.ENABLED);
+ return this.eiProducers.isJobEnabled(job)
+ ? new ConsumerEiJobStatus(ConsumerEiJobStatus.EiJobStatusValues.ENABLED)
+ : new ConsumerEiJobStatus(ConsumerEiJobStatus.EiJobStatusValues.DISABLED);
+
}
@DeleteMapping(path = "/eijobs/{eiJobId}", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI job", notes = "")
+ @Operation(summary = "Individual EI job", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "Not used", response = VoidResponse.class),
- @ApiResponse(code = 204, message = "Job deleted", response = VoidResponse.class),
@ApiResponse(
- code = 404,
- message = "Enrichment Information job is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "200",
+ description = "Not used", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))),
+ @ApiResponse(
+ responseCode = "204",
+ description = "Job deleted", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information job is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public ResponseEntity<Object> deleteIndividualEiJob( //
@PathVariable("eiJobId") String eiJobId) {
try {
EiJob job = this.eiJobs.getJob(eiJobId);
- this.eiJobs.remove(job);
- this.producerCallbacks.notifyProducersJobDeleted(job);
+ this.eiJobs.remove(job, this.eiProducers);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
} catch (Exception e) {
return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
path = "/eijobs/{eiJobId}", //
produces = MediaType.APPLICATION_JSON_VALUE, //
consumes = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI job", notes = "")
+ @Operation(summary = "Individual EI job", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 201, message = "Job created", response = VoidResponse.class), //
- @ApiResponse(code = 200, message = "Job updated", response = VoidResponse.class), // ,
@ApiResponse(
- code = 404,
- message = "Enrichment Information type is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "201",
+ description = "Job created", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "200",
+ description = "Job updated", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information type is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public Mono<ResponseEntity<Object>> putIndividualEiJob( //
@PathVariable("eiJobId") String eiJobId, //
@RequestBody ConsumerEiJobInfo eiJobObject) {
final boolean isNewJob = this.eiJobs.get(eiJobId) == null;
return validatePutEiJob(eiJobId, eiJobObject) //
- .flatMap(this::notifyProducersNewJob) //
+ .flatMap(this::startEiJob) //
.doOnNext(newEiJob -> this.eiJobs.put(newEiJob)) //
.flatMap(newEiJob -> Mono.just(new ResponseEntity<>(isNewJob ? HttpStatus.CREATED : HttpStatus.OK)))
.onErrorResume(throwable -> Mono.just(ErrorResponse.create(throwable, HttpStatus.NOT_FOUND)));
}
- private Mono<EiJob> notifyProducersNewJob(EiJob newEiJob) {
- return this.producerCallbacks.notifyProducersJobStarted(newEiJob) //
- .flatMap(noOfAcceptingProducers -> {
- if (noOfAcceptingProducers.intValue() > 0) {
- return Mono.just(newEiJob);
- } else {
- return Mono.error(new ServiceException("Job not accepted by any producers", HttpStatus.CONFLICT));
- }
- });
+ private Mono<EiJob> startEiJob(EiJob newEiJob) {
+ return this.producerCallbacks.startEiJob(newEiJob, eiProducers) //
+ .doOnNext(noOfAcceptingProducers -> this.logger.debug(
+ "Started EI job {}, number of activated producers: {}", newEiJob.getId(), noOfAcceptingProducers)) //
+ .flatMap(noOfAcceptingProducers -> Mono.just(newEiJob));
}
private Mono<EiJob> validatePutEiJob(String eiJobId, ConsumerEiJobInfo eiJobInfo) {
try {
EiType eiType = this.eiTypes.getType(eiJobInfo.eiTypeId);
- validateJsonObjectAgainstSchema(eiType.getJobDataSchema(), eiJobInfo.jobData);
+ validateJsonObjectAgainstSchema(eiType.getJobDataSchema(), eiJobInfo.jobDefinition);
EiJob existingEiJob = this.eiJobs.get(eiJobId);
- if (existingEiJob != null && !existingEiJob.type().getId().equals(eiJobInfo.eiTypeId)) {
+ if (existingEiJob != null && !existingEiJob.getTypeId().equals(eiJobInfo.eiTypeId)) {
throw new ServiceException("Not allowed to change type for existing EI job", HttpStatus.CONFLICT);
}
return Mono.just(toEiJob(eiJobInfo, eiJobId, eiType));
String schemaAsString = mapper.writeValueAsString(schemaObj);
JSONObject schemaJSON = new JSONObject(schemaAsString);
- Schema schema = SchemaLoader.load(schemaJSON);
+ org.everit.json.schema.Schema schema = org.everit.json.schema.loader.SchemaLoader.load(schemaJSON);
String objectAsString = mapper.writeValueAsString(object);
JSONObject json = new JSONObject(objectAsString);
}
}
- // Status TBD
-
private EiJob toEiJob(ConsumerEiJobInfo info, String id, EiType type) {
- return ImmutableEiJob.builder() //
+ return EiJob.builder() //
.id(id) //
- .type(type) //
+ .typeId(type.getId()) //
.owner(info.owner) //
- .jobData(info.jobData) //
- .targetUri(info.targetUri) //
+ .jobData(info.jobDefinition) //
+ .targetUrl(info.jobResultUri) //
+ .jobStatusUrl(info.statusNotificationUri == null ? "" : info.statusNotificationUri) //
.build();
}
}
private ConsumerEiJobInfo toEiJobInfo(EiJob s) {
- return new ConsumerEiJobInfo(s.type().getId(), s.jobData(), s.owner(), s.targetUri());
+ return new ConsumerEiJobInfo(s.getTypeId(), s.getJobData(), s.getOwner(), s.getTargetUrl(),
+ s.getJobStatusUrl());
}
}
Code Review / nonrtric.git / blobdiff