1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*-
* ========================LICENSE_START=================================
* ONAP : ccsdk oran
* ======================================================================
* Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
* ======================================================================
* 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
*
* 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.
* ========================LICENSE_END===================================
*/
package org.onap.ccsdk.oran.a1policymanagementservice.controllers.v1;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
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.net.MalformedURLException;
import java.net.URL;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import org.onap.ccsdk.oran.a1policymanagementservice.controllers.VoidResponse;
import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policy;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Service;
import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
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;
@RestController
@Tag(name = Consts.V1_API_NAME)
public class ServiceController {
private final Services services;
private final Policies policies;
private static Gson gson = new GsonBuilder().create();
@Autowired
ServiceController(Services services, Policies policies) {
this.services = services;
this.policies = policies;
}
@GetMapping("/services")
@Operation(summary = "Returns service information")
@ApiResponses(value = { //
@ApiResponse(responseCode = "200", //
description = "OK", //
content = @Content(array = @ArraySchema(schema = @Schema(implementation = ServiceStatus.class)))), //
@ApiResponse(responseCode = "404", //
description = "Service is not found", //
content = @Content(schema = @Schema(implementation = String.class))) //
})
public ResponseEntity<String> getServices(//
@Parameter(name = "name", required = false, description = "The name of the service") //
@RequestParam(name = "name", required = false) String name) {
if (name != null && this.services.get(name) == null) {
return new ResponseEntity<>("Service not found", HttpStatus.NOT_FOUND);
}
Collection<ServiceStatus> servicesStatus = new ArrayList<>();
for (Service s : this.services.getAll()) {
if (name == null || name.equals(s.getName())) {
servicesStatus.add(toServiceStatus(s));
}
}
String res = gson.toJson(servicesStatus);
return new ResponseEntity<>(res, HttpStatus.OK);
}
private ServiceStatus toServiceStatus(Service s) {
return new ServiceStatus(s.getName(), s.getKeepAliveInterval().toSeconds(), s.timeSinceLastPing().toSeconds(),
s.getCallbackUrl());
}
private void validateRegistrationInfo(ServiceRegistrationInfo registrationInfo)
throws ServiceException, MalformedURLException {
if (registrationInfo.serviceName.isEmpty()) {
throw new ServiceException("Missing mandatory parameter 'serviceName'");
}
if (registrationInfo.keepAliveIntervalSeconds < 0) {
throw new ServiceException("Keepalive interval should be greater or equal to 0");
}
if (!registrationInfo.callbackUrl.isEmpty()) {
new URL(registrationInfo.callbackUrl);
}
}
@Operation(summary = "Register a service")
@ApiResponses(value = { //
@ApiResponse(responseCode = "200", //
description = "Service updated", //
content = @Content(schema = @Schema(implementation = String.class))), //
@ApiResponse(responseCode = "201", //
description = "Service created", //
content = @Content(schema = @Schema(implementation = String.class))), //
@ApiResponse(responseCode = "400", //
description = "The ServiceRegistrationInfo is not accepted", //
content = @Content(schema = @Schema(implementation = String.class))) //
})
@PutMapping("/service")
public ResponseEntity<String> putService(//
@RequestBody ServiceRegistrationInfo registrationInfo) {
try {
validateRegistrationInfo(registrationInfo);
final boolean isCreate = this.services.get(registrationInfo.serviceName) == null;
this.services.put(toService(registrationInfo));
return new ResponseEntity<>("OK", isCreate ? HttpStatus.CREATED : HttpStatus.OK);
} catch (Exception e) {
return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
}
}
@Operation(summary = "Delete a service")
@ApiResponses(value = { //
@ApiResponse(responseCode = "204", description = "Service deleted"),
@ApiResponse(responseCode = "204", description = "Not used",
content = @Content(schema = @Schema(implementation = VoidResponse.class))),
@ApiResponse(responseCode = "404", description = "Service not found",
content = @Content(schema = @Schema(implementation = String.class)))})
@DeleteMapping("/services")
public ResponseEntity<String> deleteService(//
@Parameter(name = "name", required = true, description = "The name of the service") //
@RequestParam(name = "name", required = true) String serviceName) {
try {
Service service = removeService(serviceName);
// Remove the policies from the repo and let the consistency monitoring
// do the rest.
removePolicies(service);
return new ResponseEntity<>("OK", HttpStatus.NO_CONTENT);
} catch (Exception e) {
return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
}
}
@Operation(summary = "Heartbeat from a service")
@ApiResponses(value = { //
@ApiResponse(responseCode = "200", description = "Service supervision timer refreshed, OK"),
@ApiResponse(responseCode = "404", description = "The service is not found, needs re-registration")
})
@PutMapping("/services/keepalive")
public ResponseEntity<String> keepAliveService(//
@Parameter(name = "name", required = true, description = "The name of the service") //
@RequestParam(name = "name", required = true) String serviceName) {
try {
services.getService(serviceName).keepAlive();
return new ResponseEntity<>("OK", HttpStatus.OK);
} catch (ServiceException e) {
return new ResponseEntity<>(e.getMessage(), HttpStatus.NOT_FOUND);
}
}
private Service removeService(String name) throws ServiceException {
Service service = this.services.getService(name); // Just to verify that it exists
this.services.remove(service.getName());
return service;
}
private void removePolicies(Service service) {
Collection<Policy> policyList = this.policies.getForService(service.getName());
for (Policy policy : policyList) {
this.policies.remove(policy);
}
}
private Service toService(ServiceRegistrationInfo s) {
return new Service(s.serviceName, Duration.ofSeconds(s.keepAliveIntervalSeconds), s.callbackUrl);
}
}
|
