gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2019-2020 Nordix Foundation. All rights reserved.
   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.onap.ccsdk.oran.a1policymanagementservice.controllers.v2;
  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.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
  37 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  38 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  39 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  40 import org.springframework.beans.factory.annotation.Autowired;
  41 import org.springframework.http.HttpStatus;
  42 import org.springframework.http.MediaType;
  43 import org.springframework.http.ResponseEntity;
  44 import org.springframework.web.bind.annotation.GetMapping;
  45 import org.springframework.web.bind.annotation.RequestParam;
  46 import org.springframework.web.bind.annotation.RestController;
  47
  48 @RestController("RicRepositoryControllerV2")
  49 @Api(tags = {Consts.V2_API_NAME})
  50 public class RicRepositoryController {
  51
  52     @Autowired
  53     private Rics rics;
  54
  55     @Autowired
  56     PolicyTypes types;
  57
  58     private static Gson gson = new GsonBuilder() //
  59         .serializeNulls() //
  60         .create(); //
  61
  62     private static final String GET_RIC_BRIEF = "Returns info for a Near-RT RIC";
  63     private static final String GET_RIC_DETAILS =
  64         "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>" //
  65             + "The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).";
  66
  67     /**
  68      * Example: http://localhost:8081/v2/ric?managed_element_id=kista_1
  69      */
  70     @GetMapping(path = Consts.V2_API_ROOT + "/ric", produces = MediaType.APPLICATION_JSON_VALUE)
  71     @ApiOperation(value = GET_RIC_BRIEF, notes = GET_RIC_DETAILS)
  72     @ApiResponses(
  73         value = { //
  74             @ApiResponse(code = 200, message = "Near-RT RIC is found", response = RicInfo.class), //
  75             @ApiResponse(code = 404, message = "Near-RT RIC is not found", response = ErrorResponse.ErrorInfo.class) //
  76         })
  77     public ResponseEntity<Object> getRic( //
  78         @ApiParam(
  79             name = Consts.MANAGED_ELEMENT_ID_PARAM,
  80             required = false,
  81             value = "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.") //
  82         @RequestParam(name = Consts.MANAGED_ELEMENT_ID_PARAM, required = false) String managedElementId,
  83         @ApiParam(
  84             name = Consts.RIC_ID_PARAM,
  85             required = false,
  86             value = "The identity of a Near-RT RIC to get information for.") //
  87         @RequestParam(name = Consts.RIC_ID_PARAM, required = false) String ricId) {
  88         try {
  89             if (managedElementId != null && ricId != null) {
  90                 return ErrorResponse.create("Give one query parameter", HttpStatus.BAD_REQUEST);
  91             } else if (managedElementId != null) {
  92                 Optional<Ric> ric = this.rics.lookupRicForManagedElement(managedElementId);
  93                 if (ric.isPresent()) {
  94                     return new ResponseEntity<>(gson.toJson(toRicInfo(ric.get())), HttpStatus.OK);
  95                 } else {
  96                     return ErrorResponse.create("No Near-RT RIC managing the ME is found", HttpStatus.NOT_FOUND);
  97                 }
  98             } else if (ricId != null) {
  99                 RicInfo info = toRicInfo(this.rics.getRic(ricId));
 100                 return new ResponseEntity<>(gson.toJson(info), HttpStatus.OK);
 101             } else {
 102                 return ErrorResponse.create("Give one query parameter", HttpStatus.BAD_REQUEST);
 103             }
 104         } catch (ServiceException e) {
 105             return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
 106         }
 107     }
 108
 109     static final String QUERY_RIC_INFO_DETAILS =
 110         "The call returns all Near-RT RICs that supports a given policy type identity";
 111
 112     /**
 113      * @return a Json array of all RIC data Example: http://localhost:8081/v2/ric
 114      */
 115     @GetMapping(path = Consts.V2_API_ROOT + "/rics", produces = MediaType.APPLICATION_JSON_VALUE)
 116     @ApiOperation(value = "Query Near-RT RIC information", notes = QUERY_RIC_INFO_DETAILS)
 117     @ApiResponses(
 118         value = { //
 119             @ApiResponse(code = 200, message = "OK", response = RicInfoList.class), //
 120             @ApiResponse(code = 404, message = "Policy type is not found", response = ErrorResponse.ErrorInfo.class)})
 121     public ResponseEntity<Object> getRics( //
 122         @ApiParam(
 123             name = Consts.POLICY_TYPE_ID_PARAM,
 124             required = false,
 125             value = "The identity of a policy type. If given, all Near-RT RICs supporteing the policy type are returned") //
 126         @RequestParam(name = Consts.POLICY_TYPE_ID_PARAM, required = false) String supportingPolicyType) {
 127         if ((supportingPolicyType != null) && (this.types.get(supportingPolicyType) == null)) {
 128             return ErrorResponse.create("Policy type not found", HttpStatus.NOT_FOUND);
 129         }
 130
 131         List<RicInfo> result = new ArrayList<>();
 132         for (Ric ric : rics.getRics()) {
 133             if (supportingPolicyType == null || ric.isSupportingType(supportingPolicyType)) {
 134                 result.add(toRicInfo(ric));
 135             }
 136         }
 137
 138         return new ResponseEntity<>(gson.toJson(new RicInfoList(result)), HttpStatus.OK);
 139     }
 140
 141     private RicInfo.RicState toRicState(Ric.RicState state) {
 142         switch (state) {
 143             case AVAILABLE:
 144                 return RicInfo.RicState.AVAILABLE;
 145             case CONSISTENCY_CHECK:
 146                 return RicInfo.RicState.CONSISTENCY_CHECK;
 147             case SYNCHRONIZING:
 148                 return RicInfo.RicState.SYNCHRONIZING;
 149             case UNAVAILABLE:
 150                 return RicInfo.RicState.UNAVAILABLE;
 151             default:
 152                 return RicInfo.RicState.UNAVAILABLE;
 153         }
 154     }
 155
 156     private RicInfo toRicInfo(Ric ric) {
 157         return new RicInfo(ric.id(), ric.getManagedElementIds(), ric.getSupportedPolicyTypeNames(),
 158             toRicState(ric.getState()));
 159     }
 160 }