Merge "Remove dashboard"
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / controllers / ServiceController.java
1 /*-
2  * ========================LICENSE_START=================================
3  * O-RAN-SC
4  * %%
5  * Copyright (C) 2019 Nordix Foundation
6  * %%
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
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
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===================================
19  */
20
21 package org.oransc.policyagent.controllers;
22
23 import com.google.gson.Gson;
24 import com.google.gson.GsonBuilder;
25
26 import io.swagger.annotations.Api;
27 import io.swagger.annotations.ApiOperation;
28 import io.swagger.annotations.ApiResponse;
29 import io.swagger.annotations.ApiResponses;
30
31 import java.time.Duration;
32 import java.util.ArrayList;
33 import java.util.Collection;
34 import java.util.List;
35
36 import org.oransc.policyagent.exceptions.ServiceException;
37 import org.oransc.policyagent.repository.Policies;
38 import org.oransc.policyagent.repository.Policy;
39 import org.oransc.policyagent.repository.Service;
40 import org.oransc.policyagent.repository.Services;
41 import org.springframework.beans.factory.annotation.Autowired;
42 import org.springframework.http.HttpStatus;
43 import org.springframework.http.ResponseEntity;
44 import org.springframework.web.bind.annotation.DeleteMapping;
45 import org.springframework.web.bind.annotation.GetMapping;
46 import org.springframework.web.bind.annotation.PostMapping;
47 import org.springframework.web.bind.annotation.PutMapping;
48 import org.springframework.web.bind.annotation.RequestBody;
49 import org.springframework.web.bind.annotation.RequestParam;
50 import org.springframework.web.bind.annotation.RestController;
51
52 @RestController
53 @Api(tags = "Service registry and supervision")
54 public class ServiceController {
55
56     private final Services services;
57     private final Policies policies;
58
59     private static Gson gson = new GsonBuilder() //
60         .create(); //
61
62     @Autowired
63     ServiceController(Services services, Policies policies) {
64         this.services = services;
65         this.policies = policies;
66     }
67
68     @GetMapping("/services")
69     @ApiOperation(value = "Returns service information")
70     @ApiResponses(
71         value = { //
72             @ApiResponse(code = 200, message = "OK", response = ServiceStatus.class, responseContainer = "List"), //
73             @ApiResponse(code = 404, message = "Service is not found", response = String.class)})
74     public ResponseEntity<String> getServices(//
75         @RequestParam(name = "name", required = false) String name) {
76
77         if (name != null && this.services.get(name) == null) {
78             return new ResponseEntity<>("Service not found", HttpStatus.NOT_FOUND);
79         }
80
81         Collection<ServiceStatus> servicesStatus = new ArrayList<>();
82         synchronized (this.services) {
83             for (Service s : this.services.getAll()) {
84                 if (name == null || name.equals(s.getName())) {
85                     servicesStatus.add(toServiceStatus(s));
86                 }
87             }
88         }
89
90         String res = gson.toJson(servicesStatus);
91         return new ResponseEntity<>(res, HttpStatus.OK);
92     }
93
94     private ServiceStatus toServiceStatus(Service s) {
95         return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds(),
96             s.getCallbackUrl());
97     }
98
99     private void validateRegistrationInfo(ServiceRegistrationInfo registrationInfo) throws ServiceException {
100         if (registrationInfo.serviceName.isEmpty()) {
101             throw new ServiceException("Missing mandatory parameter 'serviceName'");
102         }
103     }
104
105     @ApiOperation(value = "Register a service")
106     @ApiResponses(
107         value = { //
108             @ApiResponse(code = 200, message = "Service updated", response = String.class),
109             @ApiResponse(code = 201, message = "Service created", response = String.class), //
110             @ApiResponse(code = 400, message = "Cannot parse the ServiceRegistrationInfo", response = String.class)})
111     @PutMapping("/service")
112     public ResponseEntity<String> putService(//
113         @RequestBody ServiceRegistrationInfo registrationInfo) {
114         try {
115             validateRegistrationInfo(registrationInfo);
116             final boolean isCreate = this.services.get(registrationInfo.serviceName) == null;
117             this.services.put(toService(registrationInfo));
118             return new ResponseEntity<>("OK", isCreate ? HttpStatus.CREATED : HttpStatus.OK);
119         } catch (Exception e) {
120             return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
121         }
122     }
123
124     @ApiOperation(value = "Delete a service")
125     @ApiResponses(
126         value = { //
127             @ApiResponse(code = 204, message = "OK"),
128             @ApiResponse(code = 404, message = "Service not found", response = String.class)})
129     @DeleteMapping("/services")
130     public ResponseEntity<String> deleteService(//
131         @RequestParam(name = "name", required = true) String serviceName) {
132         try {
133             Service service = removeService(serviceName);
134             // Remove the policies from the repo and let the consistency monitoring
135             // do the rest.
136             removePolicies(service);
137             return new ResponseEntity<>("OK", HttpStatus.NO_CONTENT);
138         } catch (Exception e) {
139             return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
140         }
141     }
142
143     @ApiOperation(value = "Heartbeat from a serice")
144     @ApiResponses(
145         value = { //
146             @ApiResponse(code = 200, message = "Service supervision timer refreshed, OK"),
147             @ApiResponse(code = 404, message = "The service is not found, needs re-registration")})
148     @PostMapping("/services/keepalive")
149     public ResponseEntity<String> keepAliveService(//
150         @RequestParam(name = "name", required = true) String serviceName) {
151         try {
152             services.getService(serviceName).keepAlive();
153             return new ResponseEntity<>("OK", HttpStatus.OK);
154         } catch (ServiceException e) {
155             return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
156         }
157     }
158
159     private Service removeService(String name) throws ServiceException {
160         synchronized (this.services) {
161             Service service = this.services.getService(name);
162             this.services.remove(service.getName());
163             return service;
164         }
165     }
166
167     private void removePolicies(Service service) {
168         synchronized (this.policies) {
169             List<Policy> policyList = new ArrayList<>(this.policies.getForService(service.getName()));
170             for (Policy policy : policyList) {
171                 this.policies.remove(policy);
172             }
173         }
174     }
175
176     private Service toService(ServiceRegistrationInfo s) {
177         return new Service(s.serviceName, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl);
178     }
179
180 }