Merge "Update developer guide"
[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
26 import io.swagger.annotations.Api;
27 import io.swagger.annotations.ApiOperation;
28 import io.swagger.annotations.ApiParam;
29 import io.swagger.annotations.ApiResponse;
30 import io.swagger.annotations.ApiResponses;
31
32 import java.util.ArrayList;
33 import java.util.List;
34 import java.util.Optional;
35
36 import org.oransc.policyagent.repository.PolicyTypes;
37 import org.oransc.policyagent.repository.Ric;
38 import org.oransc.policyagent.repository.Rics;
39 import org.springframework.beans.factory.annotation.Autowired;
40 import org.springframework.http.HttpStatus;
41 import org.springframework.http.ResponseEntity;
42 import org.springframework.web.bind.annotation.GetMapping;
43 import org.springframework.web.bind.annotation.RequestParam;
44 import org.springframework.web.bind.annotation.RestController;
45
46 @RestController
47 @Api(tags = "RIC Repository")
48 public class RicRepositoryController {
49
50     @Autowired
51     private Rics rics;
52
53     @Autowired
54     PolicyTypes types;
55
56     private static Gson gson = new GsonBuilder() //
57         .serializeNulls() //
58         .create(); //
59
60     /**
61      * Example: http://localhost:8081/rics?managedElementId=kista_1
62      */
63     @GetMapping("/ric")
64     @ApiOperation(value = "Returns the name of a RIC managing one Mananged Element")
65     @ApiResponses(
66         value = { //
67             @ApiResponse(code = 200, message = "RIC is found", response = String.class), //
68             @ApiResponse(code = 404, message = "RIC is not found", response = String.class) //
69         })
70     public ResponseEntity<String> getRic( //
71         @ApiParam(name = "managedElementId", required = true, value = "The ID of the Managed Element") //
72         @RequestParam(name = "managedElementId", required = true) String managedElementId) {
73         Optional<Ric> ric = this.rics.lookupRicForManagedElement(managedElementId);
74
75         if (ric.isPresent()) {
76             return new ResponseEntity<>(ric.get().name(), HttpStatus.OK);
77         } else {
78             return new ResponseEntity<>("No RIC found", HttpStatus.NOT_FOUND);
79         }
80     }
81
82     /**
83      * @return a Json array of all RIC data Example: http://localhost:8081/ric
84      */
85     @GetMapping("/rics")
86     @ApiOperation(value = "Query Near-RT RIC information")
87     @ApiResponses(
88         value = { //
89             @ApiResponse(code = 200, message = "OK", response = RicInfo.class, responseContainer = "List"), //
90             @ApiResponse(code = 404, message = "Policy type is not found", response = String.class)})
91     public ResponseEntity<String> getRics( //
92         @ApiParam(name = "policyType", required = false, value = "The name of the policy type") //
93         @RequestParam(name = "policyType", required = false) String supportingPolicyType) {
94         if ((supportingPolicyType != null) && (this.types.get(supportingPolicyType) == null)) {
95             return new ResponseEntity<>("Policy type not found", HttpStatus.NOT_FOUND);
96         }
97
98         List<RicInfo> result = new ArrayList<>();
99         for (Ric ric : rics.getRics()) {
100             if (supportingPolicyType == null || ric.isSupportingType(supportingPolicyType)) {
101                 result.add(new RicInfo(ric.name(), ric.getManagedElementIds(), ric.getSupportedPolicyTypeNames(),
102                     ric.getState().toString()));
103             }
104         }
105
106         return new ResponseEntity<>(gson.toJson(result), HttpStatus.OK);
107     }
108
109 }