/*-
* ========================LICENSE_START=================================
- * ONAP : ccsdk oran
- * ======================================================================
- * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
- * ======================================================================
+ * O-RAN-SC
+ * %%
+ * Copyright (C) 2020 Nordix Foundation
+ * %%
* 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
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-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.Collection;
import java.util.List;
-import org.oransc.enrichment.clients.ProducerCallbacks;
-import org.oransc.enrichment.clients.ProducerJobInfo;
import org.oransc.enrichment.controllers.ErrorResponse;
-import org.oransc.enrichment.controllers.producer.ProducerRegistrationInfo.ProducerEiTypeRegistrationInfo;
+import org.oransc.enrichment.controllers.VoidResponse;
+import org.oransc.enrichment.exceptions.ServiceException;
import org.oransc.enrichment.repository.EiJob;
import org.oransc.enrichment.repository.EiJobs;
import org.oransc.enrichment.repository.EiProducer;
import org.oransc.enrichment.repository.EiProducers;
import org.oransc.enrichment.repository.EiType;
import org.oransc.enrichment.repository.EiTypes;
-import org.oransc.enrichment.repository.ImmutableEiProducer;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.oransc.enrichment.repository.ImmutableEiProducerRegistrationInfo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
-@RestController("ProducerController")
-@Api(tags = {ProducerConsts.PRODUCER_API_NAME})
+@RestController("Producer registry")
+@Tag(name = ProducerConsts.PRODUCER_API_NAME)
public class ProducerController {
- private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
-
- private static Gson gson = new GsonBuilder() //
- .serializeNulls() //
- .create(); //
+ private static Gson gson = new GsonBuilder().create();
@Autowired
private EiJobs eiJobs;
@Autowired
private EiProducers eiProducers;
- @Autowired
- ProducerCallbacks producerCallbacks;
-
- @GetMapping(path = ProducerConsts.API_ROOT + "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI type identifiers", notes = "")
+ @GetMapping(path = ProducerConsts.API_ROOT + "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE) //
+ @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 = ProducerConsts.API_ROOT + "/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 = ProducerEiTypeInfo.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 = ProducerEiTypeInfo.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 {
}
}
+ @PutMapping(path = ProducerConsts.API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
+ @ApiResponses(
+ value = { //
+ @ApiResponse(
+ responseCode = "200",
+ description = "Type updated", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "201",
+ description = "Type created", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "400",
+ description = "Bad request", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class)))})
+ @Operation(summary = "Individual EI type", description = "")
+ public ResponseEntity<Object> putEiType( //
+ @PathVariable("eiTypeId") String eiTypeId, //
+ @RequestBody ProducerEiTypeInfo registrationInfo) {
+
+ EiType previousDefinition = this.eiTypes.get(eiTypeId);
+ if (registrationInfo.jobDataSchema == null) {
+ return ErrorResponse.create("No schema provided", HttpStatus.BAD_REQUEST);
+ }
+ this.eiTypes.put(new EiType(eiTypeId, registrationInfo.jobDataSchema));
+ return new ResponseEntity<>(previousDefinition == null ? HttpStatus.CREATED : HttpStatus.OK);
+ }
+
+ @DeleteMapping(path = ProducerConsts.API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE) //
+ @Operation(summary = "Individual EI type", description = "") //
+ @ApiResponses(
+ value = { //
+ @ApiResponse(
+ responseCode = "200",
+ description = "Not used", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "204",
+ description = "Producer deleted", //
+ 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))), //
+ @ApiResponse(
+ responseCode = "406",
+ description = "The Enrichment Information type has one or several active producers", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
+ public ResponseEntity<Object> deleteEiType( //
+ @PathVariable("eiTypeId") String eiTypeId) {
+
+ EiType type = this.eiTypes.get(eiTypeId);
+ if (type == null) {
+ return ErrorResponse.create("EI type not found", HttpStatus.NOT_FOUND);
+ }
+ if (!this.eiProducers.getProducersForType(type).isEmpty()) {
+ String firstProducerId = this.eiProducers.getProducersForType(type).iterator().next().getId();
+ return ErrorResponse.create("The type has active producers: " + firstProducerId, HttpStatus.NOT_ACCEPTABLE);
+ }
+ this.eiTypes.remove(type);
+ return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+ }
+
@GetMapping(path = ProducerConsts.API_ROOT + "/eiproducers", produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI producer identifiers", notes = "")
+ @Operation(summary = "EI producer identifiers", description = "")
@ApiResponses(
value = { //
@ApiResponse(
- code = 200,
- message = "EI producer identifiers",
- response = String.class,
- responseContainer = "List"), //
+ responseCode = "200",
+ description = "EI producer identifiers", //
+ content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))) //
})
public ResponseEntity<Object> getEiProducerIdentifiers( //
+ @Parameter(
+ name = "ei_type_id",
+ required = false,
+ description = "If given, only the producers for the EI Data type is returned.") //
+ @RequestParam(name = "ei_type_id", required = false) String typeId //
) {
List<String> result = new ArrayList<>();
- for (EiProducer eiProducer : this.eiProducers.getAllProducers()) {
- result.add(eiProducer.id());
+ for (EiProducer eiProducer : typeId == null ? this.eiProducers.getAllProducers()
+ : this.eiProducers.getProducersForType(typeId)) {
+ result.add(eiProducer.getId());
}
return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
@GetMapping(
path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}",
produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI producer", notes = "")
+ @Operation(summary = "Individual EI producer", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI Jobs", response = ProducerRegistrationInfo.class), //
@ApiResponse(
- code = 404,
- message = "Enrichment Information producer is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "200",
+ description = "EI producer", //
+ content = @Content(schema = @Schema(implementation = ProducerRegistrationInfo.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information producer is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class)))//
+ })
public ResponseEntity<Object> getEiProducer( //
@PathVariable("eiProducerId") String eiProducerId) {
try {
@GetMapping(
path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}/eijobs",
produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "EI job definitions", notes = "EI job definitions for one EI producer")
+ @Operation(summary = "EI job definitions", description = "EI job definitions for one EI producer")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "EI jobs", response = ProducerJobInfo.class, responseContainer = "List"), //
@ApiResponse(
- code = 404,
- message = "Enrichment Information producer is not found",
- response = ErrorResponse.ErrorInfo.class)})
+ responseCode = "404",
+ description = "Enrichment Information producer is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))), //
+ @ApiResponse(
+ responseCode = "200",
+ description = "EI producer", //
+ content = @Content(array = @ArraySchema(schema = @Schema(implementation = ProducerJobInfo.class)))), //
+ })
public ResponseEntity<Object> getEiProducerJobs( //
@PathVariable("eiProducerId") String eiProducerId) {
try {
EiProducer producer = this.eiProducers.getProducer(eiProducerId);
Collection<ProducerJobInfo> producerJobs = new ArrayList<>();
- for (EiType type : producer.eiTypes()) {
+ for (EiType type : producer.getEiTypes()) {
for (EiJob eiJob : this.eiJobs.getJobsForType(type)) {
ProducerJobInfo request = new ProducerJobInfo(eiJob);
producerJobs.add(request);
}
}
+ @GetMapping(
+ path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}/status",
+ produces = MediaType.APPLICATION_JSON_VALUE) //
+ @Operation(summary = "EI producer status") //
+ @ApiResponses(
+ value = { //
+ @ApiResponse(
+ responseCode = "200",
+ description = "EI producer status", //
+ content = @Content(schema = @Schema(implementation = ProducerStatusInfo.class))), //
+ @ApiResponse(
+ responseCode = "404",
+ description = "Enrichment Information producer is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
+ public ResponseEntity<Object> getEiProducerStatus( //
+ @PathVariable("eiProducerId") String eiProducerId) {
+ try {
+ EiProducer producer = this.eiProducers.getProducer(eiProducerId);
+ return new ResponseEntity<>(gson.toJson(producerStatusInfo(producer)), HttpStatus.OK);
+ } catch (Exception e) {
+ return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
+ }
+ }
+
+ private ProducerStatusInfo producerStatusInfo(EiProducer producer) {
+ ProducerStatusInfo.OperationalState opState =
+ producer.isAvailable() ? ProducerStatusInfo.OperationalState.ENABLED
+ : ProducerStatusInfo.OperationalState.DISABLED;
+ return new ProducerStatusInfo(opState);
+ }
+
@PutMapping(
- path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}",
+ path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}", //
produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI producer", notes = "")
+ @Operation(summary = "Individual EI producer", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 201, message = "Producer created", response = void.class), //
- @ApiResponse(code = 200, message = "Producer updated", response = void.class)}//
- )
+ @ApiResponse(
+ responseCode = "201",
+ description = "Producer created", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))), //
+ @ApiResponse(
+ responseCode = "200",
+ description = "Producer updated", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))) //
+ })
public ResponseEntity<Object> putEiProducer( //
@PathVariable("eiProducerId") String eiProducerId, //
@RequestBody ProducerRegistrationInfo registrationInfo) {
try {
EiProducer previousDefinition = this.eiProducers.get(eiProducerId);
- if (previousDefinition != null) {
- for (EiType type : previousDefinition.eiTypes()) {
- type.removeProducer(previousDefinition);
- }
- }
-
- registerProducer(eiProducerId, registrationInfo);
- if (previousDefinition != null) {
- purgeTypes(previousDefinition.eiTypes());
- }
-
+ this.eiProducers.registerProducer(toEiProducerRegistrationInfo(eiProducerId, registrationInfo));
return new ResponseEntity<>(previousDefinition == null ? HttpStatus.CREATED : HttpStatus.OK);
} catch (Exception e) {
return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
}
}
- private void purgeTypes(Collection<EiType> types) {
- for (EiType type : types) {
- if (type.getProducerIds().isEmpty()) {
- this.deregisterType(type);
- }
- }
- }
-
@DeleteMapping(
path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}",
produces = MediaType.APPLICATION_JSON_VALUE)
- @ApiOperation(value = "Individual EI producer", notes = "")
+ @Operation(summary = "Individual EI producer", description = "")
@ApiResponses(
value = { //
- @ApiResponse(code = 200, message = "Not used", response = void.class),
- @ApiResponse(code = 204, message = "Producer deleted", response = void.class),
- @ApiResponse(code = 404, message = "Producer is not found", response = ErrorResponse.ErrorInfo.class)})
+ @ApiResponse(
+ responseCode = "200",
+ description = "Not used", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))),
+ @ApiResponse(
+ responseCode = "204",
+ description = "Producer deleted", //
+ content = @Content(schema = @Schema(implementation = VoidResponse.class))),
+ @ApiResponse(
+ responseCode = "404",
+ description = "Producer is not found", //
+ content = @Content(schema = @Schema(implementation = ErrorResponse.ErrorInfo.class))) //
+ })
public ResponseEntity<Object> deleteEiProducer(@PathVariable("eiProducerId") String eiProducerId) {
try {
final EiProducer producer = this.eiProducers.getProducer(eiProducerId);
- deregisterProducer(producer);
+ this.eiProducers.deregisterProducer(producer);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
} catch (Exception e) {
return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
}
}
- private EiType registerType(ProducerEiTypeRegistrationInfo typeInfo) {
- EiType type = this.eiTypes.get(typeInfo.eiTypeId);
- if (type == null) {
- type = new EiType(typeInfo.eiTypeId, typeInfo.jobDataSchema);
- this.eiTypes.put(type);
+ private ProducerRegistrationInfo toEiProducerRegistrationInfo(EiProducer p) {
+ Collection<String> types = new ArrayList<>();
+ for (EiType type : p.getEiTypes()) {
+ types.add(type.getId());
}
- return type;
-
+ return new ProducerRegistrationInfo(types, p.getJobCallbackUrl(), p.getProducerSupervisionCallbackUrl());
}
- EiProducer createProducer(Collection<EiType> types, String producerId, ProducerRegistrationInfo registrationInfo) {
- return ImmutableEiProducer.builder() //
- .id(producerId) //
- .eiTypes(types) //
- .jobCreationCallbackUrl(registrationInfo.jobCreationCallbackUrl) //
- .jobDeletionCallbackUrl(registrationInfo.jobDeletionCallbackUrl) //
- .build();
- }
-
- private EiProducer registerProducer(String producerId, ProducerRegistrationInfo registrationInfo) {
- ArrayList<EiType> types = new ArrayList<>();
- for (ProducerEiTypeRegistrationInfo typeInfo : registrationInfo.types) {
- types.add(registerType(typeInfo));
- }
- EiProducer producer = createProducer(types, producerId, registrationInfo);
- this.eiProducers.put(producer);
-
- for (EiType type : types) {
- for (EiJob job : this.eiJobs.getJobsForType(type)) {
- this.producerCallbacks.notifyProducerJobStarted(producer, job);
- }
- type.addProducer(producer);
- }
- return producer;
- }
-
- private void deregisterType(EiType type) {
- this.eiTypes.remove(type);
- for (EiJob job : this.eiJobs.getJobsForType(type.getId())) {
- this.eiJobs.remove(job);
- this.logger.warn("Deleted job {} because no producers left", job.id());
- }
- }
-
- private void deregisterProducer(EiProducer producer) {
- this.eiProducers.remove(producer);
- for (EiType type : producer.eiTypes()) {
- boolean removed = type.removeProducer(producer) != null;
- if (!removed) {
- this.logger.error("Bug, no producer found");
- }
- if (type.getProducerIds().isEmpty()) {
- deregisterType(type);
- }
- }
+ private ProducerEiTypeInfo toEiTypeInfo(EiType t) {
+ return new ProducerEiTypeInfo(t.getJobDataSchema());
}
- ProducerRegistrationInfo toEiProducerRegistrationInfo(EiProducer p) {
- Collection<ProducerEiTypeRegistrationInfo> types = new ArrayList<>();
- for (EiType type : p.eiTypes()) {
- types.add(toEiTypeRegistrationInfo(type));
+ private EiProducers.EiProducerRegistrationInfo toEiProducerRegistrationInfo(String eiProducerId,
+ ProducerRegistrationInfo info) throws ServiceException {
+ Collection<EiType> supportedTypes = new ArrayList<>();
+ for (String typeId : info.supportedTypeIds) {
+ EiType type = this.eiTypes.getType(typeId);
+ supportedTypes.add(type);
}
- return new ProducerRegistrationInfo(types, p.jobCreationCallbackUrl(), p.jobDeletionCallbackUrl());
- }
- private ProducerEiTypeRegistrationInfo toEiTypeRegistrationInfo(EiType type) {
- return new ProducerEiTypeRegistrationInfo(type.getJobDataSchema(), type.getId());
+ return ImmutableEiProducerRegistrationInfo.builder() //
+ .id(eiProducerId) //
+ .jobCallbackUrl(info.jobCallbackUrl) //
+ .producerSupervisionCallbackUrl(info.producerSupervisionCallbackUrl) //
+ .supportedTypes(supportedTypes) //
+ .build();
}
- private ProducerEiTypeInfo toEiTypeInfo(EiType t) {
- return new ProducerEiTypeInfo(t.getJobDataSchema(), t.getProducerIds());
- }
}
Code Review / nonrtric.git / blobdiff