2 * ========================LICENSE_START=================================
5 * Copyright (C) 2020 Nordix Foundation
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ========================LICENSE_END===================================
21 package org.oransc.enrichment.controllers.producer;
23 import com.google.gson.Gson;
24 import com.google.gson.GsonBuilder;
26 import io.swagger.annotations.Api;
27 import io.swagger.annotations.ApiOperation;
28 import io.swagger.annotations.ApiResponse;
29 import io.swagger.annotations.ApiResponses;
31 import java.lang.invoke.MethodHandles;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.List;
36 import org.oransc.enrichment.controllers.ErrorResponse;
37 import org.oransc.enrichment.controllers.VoidResponse;
38 import org.oransc.enrichment.controllers.consumer.ConsumerCallbacks;
39 import org.oransc.enrichment.controllers.producer.ProducerRegistrationInfo.ProducerEiTypeRegistrationInfo;
40 import org.oransc.enrichment.repository.EiJob;
41 import org.oransc.enrichment.repository.EiJobs;
42 import org.oransc.enrichment.repository.EiProducer;
43 import org.oransc.enrichment.repository.EiProducers;
44 import org.oransc.enrichment.repository.EiType;
45 import org.oransc.enrichment.repository.EiTypes;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48 import org.springframework.beans.factory.annotation.Autowired;
49 import org.springframework.http.HttpStatus;
50 import org.springframework.http.MediaType;
51 import org.springframework.http.ResponseEntity;
52 import org.springframework.web.bind.annotation.DeleteMapping;
53 import org.springframework.web.bind.annotation.GetMapping;
54 import org.springframework.web.bind.annotation.PathVariable;
55 import org.springframework.web.bind.annotation.PutMapping;
56 import org.springframework.web.bind.annotation.RequestBody;
57 import org.springframework.web.bind.annotation.RestController;
59 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
60 @RestController("ProducerController")
61 @Api(tags = {ProducerConsts.PRODUCER_API_NAME})
62 public class ProducerController {
64 private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
66 private static Gson gson = new GsonBuilder().create();
69 private EiJobs eiJobs;
72 private EiTypes eiTypes;
75 private EiProducers eiProducers;
78 ProducerCallbacks producerCallbacks;
81 ConsumerCallbacks consumerCallbacks;
83 @GetMapping(path = ProducerConsts.API_ROOT + "/eitypes", produces = MediaType.APPLICATION_JSON_VALUE)
84 @ApiOperation(value = "EI type identifiers", notes = "")
89 message = "EI type identifiers",
90 response = String.class,
91 responseContainer = "List"), //
93 public ResponseEntity<Object> getEiTypeIdentifiers( //
95 List<String> result = new ArrayList<>();
96 for (EiType eiType : this.eiTypes.getAllEiTypes()) {
97 result.add(eiType.getId());
100 return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
103 @GetMapping(path = ProducerConsts.API_ROOT + "/eitypes/{eiTypeId}", produces = MediaType.APPLICATION_JSON_VALUE)
104 @ApiOperation(value = "Individual EI type", notes = "")
107 @ApiResponse(code = 200, message = "EI type", response = ProducerEiTypeInfo.class), //
110 message = "Enrichment Information type is not found",
111 response = ErrorResponse.ErrorInfo.class)})
112 public ResponseEntity<Object> getEiType( //
113 @PathVariable("eiTypeId") String eiTypeId) {
115 EiType t = this.eiTypes.getType(eiTypeId);
116 ProducerEiTypeInfo info = toEiTypeInfo(t);
117 return new ResponseEntity<>(gson.toJson(info), HttpStatus.OK);
118 } catch (Exception e) {
119 return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
123 @GetMapping(path = ProducerConsts.API_ROOT + "/eiproducers", produces = MediaType.APPLICATION_JSON_VALUE)
124 @ApiOperation(value = "EI producer identifiers", notes = "")
129 message = "EI producer identifiers",
130 response = String.class,
131 responseContainer = "List"), //
133 public ResponseEntity<Object> getEiProducerIdentifiers( //
135 List<String> result = new ArrayList<>();
136 for (EiProducer eiProducer : this.eiProducers.getAllProducers()) {
137 result.add(eiProducer.getId());
140 return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
144 path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}",
145 produces = MediaType.APPLICATION_JSON_VALUE)
146 @ApiOperation(value = "Individual EI producer", notes = "")
149 @ApiResponse(code = 200, message = "EI jobs", response = ProducerRegistrationInfo.class), //
152 message = "Enrichment Information producer is not found",
153 response = ErrorResponse.ErrorInfo.class)})
154 public ResponseEntity<Object> getEiProducer( //
155 @PathVariable("eiProducerId") String eiProducerId) {
157 EiProducer p = this.eiProducers.getProducer(eiProducerId);
158 ProducerRegistrationInfo info = toEiProducerRegistrationInfo(p);
159 return new ResponseEntity<>(gson.toJson(info), HttpStatus.OK);
160 } catch (Exception e) {
161 return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
166 path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}/eijobs",
167 produces = MediaType.APPLICATION_JSON_VALUE)
168 @ApiOperation(value = "EI job definitions", notes = "EI job definitions for one EI producer")
171 @ApiResponse(code = 200, message = "EI jobs", response = ProducerJobInfo.class, responseContainer = "List"), //
174 message = "Enrichment Information producer is not found",
175 response = ErrorResponse.ErrorInfo.class)})
176 public ResponseEntity<Object> getEiProducerJobs( //
177 @PathVariable("eiProducerId") String eiProducerId) {
179 EiProducer producer = this.eiProducers.getProducer(eiProducerId);
180 Collection<ProducerJobInfo> producerJobs = new ArrayList<>();
181 for (EiType type : producer.getEiTypes()) {
182 for (EiJob eiJob : this.eiJobs.getJobsForType(type)) {
183 ProducerJobInfo request = new ProducerJobInfo(eiJob);
184 producerJobs.add(request);
188 return new ResponseEntity<>(gson.toJson(producerJobs), HttpStatus.OK);
189 } catch (Exception e) {
190 return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
195 path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}/status",
196 produces = MediaType.APPLICATION_JSON_VALUE)
197 @ApiOperation(value = "EI producer status")
200 @ApiResponse(code = 200, message = "EI jobs", response = ProducerStatusInfo.class), //
203 message = "Enrichment Information producer is not found",
204 response = ErrorResponse.ErrorInfo.class)})
205 public ResponseEntity<Object> getEiProducerStatus( //
206 @PathVariable("eiProducerId") String eiProducerId) {
208 EiProducer producer = this.eiProducers.getProducer(eiProducerId);
209 return new ResponseEntity<>(gson.toJson(producerStatusInfo(producer)), HttpStatus.OK);
210 } catch (Exception e) {
211 return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
215 private ProducerStatusInfo producerStatusInfo(EiProducer producer) {
216 ProducerStatusInfo.OperationalState opState =
217 producer.isAvailable() ? ProducerStatusInfo.OperationalState.ENABLED
218 : ProducerStatusInfo.OperationalState.DISABLED;
219 return new ProducerStatusInfo(opState);
223 path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}",
224 produces = MediaType.APPLICATION_JSON_VALUE)
225 @ApiOperation(value = "Individual EI producer", notes = "")
228 @ApiResponse(code = 201, message = "Producer created", response = VoidResponse.class), //
229 @ApiResponse(code = 200, message = "Producer updated", response = VoidResponse.class)}//
231 public ResponseEntity<Object> putEiProducer( //
232 @PathVariable("eiProducerId") String eiProducerId, //
233 @RequestBody ProducerRegistrationInfo registrationInfo) {
235 EiProducer previousDefinition = this.eiProducers.get(eiProducerId);
236 if (previousDefinition != null) {
237 for (EiType type : previousDefinition.getEiTypes()) {
238 type.removeProducer(previousDefinition);
242 EiProducer producer = registerProducer(eiProducerId, registrationInfo);
243 if (previousDefinition != null) {
244 purgeTypes(previousDefinition.getEiTypes());
245 this.consumerCallbacks.notifyConsumersProducerDeleted(previousDefinition);
247 this.consumerCallbacks.notifyConsumersProducerAdded(producer);
249 return new ResponseEntity<>(previousDefinition == null ? HttpStatus.CREATED : HttpStatus.OK);
250 } catch (Exception e) {
251 return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
255 private void purgeTypes(Collection<EiType> types) {
256 for (EiType type : types) {
257 if (type.getProducerIds().isEmpty()) {
258 this.eiTypes.remove(type);
264 path = ProducerConsts.API_ROOT + "/eiproducers/{eiProducerId}",
265 produces = MediaType.APPLICATION_JSON_VALUE)
266 @ApiOperation(value = "Individual EI producer", notes = "")
269 @ApiResponse(code = 200, message = "Not used", response = VoidResponse.class),
270 @ApiResponse(code = 204, message = "Producer deleted", response = VoidResponse.class),
271 @ApiResponse(code = 404, message = "Producer is not found", response = ErrorResponse.ErrorInfo.class)})
272 public ResponseEntity<Object> deleteEiProducer(@PathVariable("eiProducerId") String eiProducerId) {
274 final EiProducer producer = this.eiProducers.getProducer(eiProducerId);
275 this.eiProducers.deregisterProducer(producer, this.eiTypes, this.eiJobs);
276 this.consumerCallbacks.notifyConsumersProducerDeleted(producer);
277 return new ResponseEntity<>(HttpStatus.NO_CONTENT);
278 } catch (Exception e) {
279 return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
283 private EiType registerType(ProducerEiTypeRegistrationInfo typeInfo) {
284 EiType type = this.eiTypes.get(typeInfo.eiTypeId);
286 type = new EiType(typeInfo.eiTypeId, typeInfo.jobDataSchema);
287 this.eiTypes.put(type);
288 this.consumerCallbacks.notifyConsumersTypeAdded(type);
293 EiProducer createProducer(Collection<EiType> types, String producerId, ProducerRegistrationInfo registrationInfo) {
294 return new EiProducer(producerId, types, registrationInfo.jobCallbackUrl,
295 registrationInfo.producerSupervisionCallbackUrl);
298 private EiProducer registerProducer(String producerId, ProducerRegistrationInfo registrationInfo) {
299 ArrayList<EiType> typesForProducer = new ArrayList<>();
300 EiProducer producer = createProducer(typesForProducer, producerId, registrationInfo);
301 for (ProducerEiTypeRegistrationInfo typeInfo : registrationInfo.types) {
302 EiType type = registerType(typeInfo);
303 typesForProducer.add(type);
304 type.addProducer(producer); //
306 this.eiProducers.put(producer);
308 producerCallbacks.restartJobs(producer, this.eiJobs);
313 ProducerRegistrationInfo toEiProducerRegistrationInfo(EiProducer p) {
314 Collection<ProducerEiTypeRegistrationInfo> types = new ArrayList<>();
315 for (EiType type : p.getEiTypes()) {
316 types.add(toEiTypeRegistrationInfo(type));
318 return new ProducerRegistrationInfo(types, p.getJobCallbackUrl(), p.getProducerSupervisionCallbackUrl());
321 private ProducerEiTypeRegistrationInfo toEiTypeRegistrationInfo(EiType type) {
322 return new ProducerEiTypeRegistrationInfo(type.getJobDataSchema(), type.getId());
325 private ProducerEiTypeInfo toEiTypeInfo(EiType t) {
326 return new ProducerEiTypeInfo(t.getJobDataSchema(), t.getProducerIds());