175d5eb929f8c6dd1895863f498750983a25a8ef
[nonrtric.git] / policy-agent / src / main / java / org / oransc / policyagent / controllers / RicRepositoryController.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 import io.swagger.annotations.Api;
26 import io.swagger.annotations.ApiOperation;
27 import io.swagger.annotations.ApiResponse;
28 import io.swagger.annotations.ApiResponses;
29
30 import java.util.Optional;
31 import java.util.Vector;
32
33 import org.oransc.policyagent.configuration.ApplicationConfig;
34 import org.oransc.policyagent.configuration.RicConfig;
35 import org.oransc.policyagent.repository.Ric;
36 import org.oransc.policyagent.repository.Rics;
37 import org.springframework.beans.factory.annotation.Autowired;
38 import org.springframework.http.HttpStatus;
39 import org.springframework.http.ResponseEntity;
40 import org.springframework.web.bind.annotation.GetMapping;
41 import org.springframework.web.bind.annotation.RequestParam;
42 import org.springframework.web.bind.annotation.RestController;
43
44 @RestController
45 @Api(value = "RIC Management API")
46 public class RicRepositoryController {
47
48     private final ApplicationConfig appConfig;
49
50     @Autowired
51     private Rics rics;
52
53     private static Gson gson = new GsonBuilder() //
54         .serializeNulls() //
55         .create(); //
56
57     @Autowired
58     RicRepositoryController(ApplicationConfig appConfig) {
59         this.appConfig = appConfig;
60     }
61
62     /**
63      * Example: http://localhost:8080/rics?managedElementId=kista_1
64      */
65     @GetMapping("/ric")
66     @ApiOperation(value = "Returns the name of a RIC managing one Mananged Element")
67     @ApiResponses(
68         value = { //
69             @ApiResponse(code = 200, message = "RIC is fond"), //
70             @ApiResponse(code = 404, message = "RIC is not fond") //
71         })
72     public ResponseEntity<String> getRic(
73         @RequestParam(name = "managedElementId", required = false, defaultValue = "") String managedElementId) {
74
75         Optional<RicConfig> config = appConfig.lookupRicConfigForManagedElement(managedElementId);
76
77         if (config.isPresent()) {
78             return new ResponseEntity<>(config.get().name(), HttpStatus.OK);
79         } else {
80             return new ResponseEntity<>("", HttpStatus.NOT_FOUND);
81         }
82     }
83
84     /**
85      * @return a Json array of all RIC data
86      *         Example: http://localhost:8080/ric
87      */
88     @GetMapping("/rics")
89     @ApiOperation(value = "Returns defined NearRT RIC:s as Json")
90     @ApiResponses(
91         value = { //
92             @ApiResponse(code = 200, message = "OK") //
93         })
94     public ResponseEntity<String> getRics(
95         @RequestParam(name = "policyType", required = false) String supportingPolicyType) {
96         Vector<RicInfo> result = new Vector<>();
97         for (Ric ric : rics.getRics()) {
98             if (supportingPolicyType == null || ric.isSupportingType(supportingPolicyType)) {
99                 result.add(ImmutableRicInfo.builder() //
100                     .name(ric.name()) //
101                     .nodeNames(ric.getManagedNodes()) //
102                     .policyTypes(ric.getSupportedPolicyTypeNames()) //
103                     .build());
104             }
105         }
106
107         return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
108     }
109
110 }