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
  35 import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.EntityNotFoundException;
  36 import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.InvalidRequestException;
  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             .create(); //
  60
  61     private static final String GET_RIC_BRIEF = "Returns info for one Near-RT RIC";
  62     private static final String GET_RIC_DETAILS =
  63             "Either a Near-RT RIC identity or a Mananged Element identity can be specified.<br>" //
  64                     + "The intention with Mananged Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).";
  65
  66     /**
  67      * Example: http://localhost:8081/v2/rics/ric?managed_element_id=kista_1
  68      *
  69      * @throws EntityNotFoundException
  70      */
  71     @GetMapping(path = Consts.V2_API_ROOT + "/rics/ric", produces = MediaType.APPLICATION_JSON_VALUE)
  72     @ApiOperation(value = GET_RIC_BRIEF, notes = GET_RIC_DETAILS)
  73     @ApiResponses(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(name = Consts.MANAGED_ELEMENT_ID_PARAM, required = false,
  79                     value = "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.") //
  80             @RequestParam(name = Consts.MANAGED_ELEMENT_ID_PARAM, required = false) String managedElementId,
  81             @ApiParam(name = Consts.RIC_ID_PARAM, required = false,
  82                     value = "The identity of a Near-RT RIC to get information for.") //
  83             @RequestParam(name = Consts.RIC_ID_PARAM, required = false) String ricId)
  84             throws EntityNotFoundException, InvalidRequestException {
  85         if (managedElementId != null && ricId != null) {
  86             throw new InvalidRequestException("Give one query parameter");
  87         } else if (managedElementId != null) {
  88             Ric ric = this.rics.lookupRicForManagedElement(managedElementId);
  89             return new ResponseEntity<>(gson.toJson(toRicInfo(ric)), HttpStatus.OK);
  90         } else if (ricId != null) {
  91             RicInfo info = toRicInfo(this.rics.getRic(ricId));
  92             return new ResponseEntity<>(gson.toJson(info), HttpStatus.OK);
  93         } else {
  94             throw new InvalidRequestException("Give one query parameter");
  95         }
  96     }
  97
  98     static final String QUERY_RIC_INFO_DETAILS =
  99             "The call returns all Near-RT RICs that supports a given policy type identity";
 100
 101     /**
 102      * @return a Json array of all RIC data Example: http://localhost:8081/v2/ric
 103      * @throws EntityNotFoundException
 104      */
 105     @GetMapping(path = Consts.V2_API_ROOT + "/rics", produces = MediaType.APPLICATION_JSON_VALUE)
 106     @ApiOperation(value = "Query Near-RT RIC information", notes = QUERY_RIC_INFO_DETAILS)
 107     @ApiResponses(value = { //
 108             @ApiResponse(code = 200, message = "OK", response = RicInfoList.class), //
 109             @ApiResponse(code = 404, message = "Policy type is not found", response = ErrorResponse.ErrorInfo.class)})
 110     public ResponseEntity<Object> getRics( //
 111             @ApiParam(name = Consts.POLICY_TYPE_ID_PARAM, required = false,
 112                     value = "The identity of a policy type. If given, all Near-RT RICs supporteing the policy type are returned") //
 113             @RequestParam(name = Consts.POLICY_TYPE_ID_PARAM, required = false) String supportingPolicyType)
 114             throws EntityNotFoundException {
 115         if ((supportingPolicyType != null) && (this.types.get(supportingPolicyType) == null)) {
 116             throw new EntityNotFoundException("Policy type not found");
 117         }
 118
 119         List<RicInfo> result = new ArrayList<>();
 120         for (Ric ric : rics.getRics()) {
 121             if (supportingPolicyType == null || ric.isSupportingType(supportingPolicyType)) {
 122                 result.add(toRicInfo(ric));
 123             }
 124         }
 125
 126         return new ResponseEntity<>(gson.toJson(new RicInfoList(result)), HttpStatus.OK);
 127     }
 128
 129     private RicInfo.RicState toRicState(Ric.RicState state) {
 130         switch (state) {
 131             case AVAILABLE:
 132                 return RicInfo.RicState.AVAILABLE;
 133             case CONSISTENCY_CHECK:
 134                 return RicInfo.RicState.CONSISTENCY_CHECK;
 135             case SYNCHRONIZING:
 136                 return RicInfo.RicState.SYNCHRONIZING;
 137             case UNAVAILABLE:
 138                 return RicInfo.RicState.UNAVAILABLE;
 139             default:
 140                 return RicInfo.RicState.UNAVAILABLE;
 141         }
 142     }
 143
 144     private RicInfo toRicInfo(Ric ric) {
 145         return new RicInfo(ric.id(), ric.getManagedElementIds(), ric.getSupportedPolicyTypeNames(),
 146                 toRicState(ric.getState()));
 147     }
 148 }