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(value = { //
  73             @ApiResponse(code = 200, message = "Near-RT RIC is found", response = RicInfo.class), //
  74             @ApiResponse(code = 404, message = "Near-RT RIC is not found", response = ErrorResponse.ErrorInfo.class) //
  75     })
  76     public ResponseEntity<Object> getRic( //
  77             @ApiParam(name = Consts.MANAGED_ELEMENT_ID_PARAM, required = false,
  78                     value = "The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.") //
  79             @RequestParam(name = Consts.MANAGED_ELEMENT_ID_PARAM, required = false) String managedElementId,
  80             @ApiParam(name = Consts.RIC_ID_PARAM, required = false,
  81                     value = "The identity of a Near-RT RIC to get information for.") //
  82             @RequestParam(name = Consts.RIC_ID_PARAM, required = false) String ricId) {
  83         try {
  84             if (managedElementId != null && ricId != null) {
  85                 return ErrorResponse.create("Give one query parameter", HttpStatus.BAD_REQUEST);
  86             } else if (managedElementId != null) {
  87                 Optional<Ric> ric = this.rics.lookupRicForManagedElement(managedElementId);
  88                 if (ric.isPresent()) {
  89                     return new ResponseEntity<>(gson.toJson(toRicInfo(ric.get())), HttpStatus.OK);
  90                 } else {
  91                     return ErrorResponse.create("No Near-RT RIC managing the ME is found", HttpStatus.NOT_FOUND);
  92                 }
  93             } else if (ricId != null) {
  94                 RicInfo info = toRicInfo(this.rics.getRic(ricId));
  95                 return new ResponseEntity<>(gson.toJson(info), HttpStatus.OK);
  96             } else {
  97                 return ErrorResponse.create("Give one query parameter", HttpStatus.BAD_REQUEST);
  98             }
  99         } catch (ServiceException e) {
 100             return ErrorResponse.create(e, HttpStatus.NOT_FOUND);
 101         }
 102     }
 103
 104     static final String QUERY_RIC_INFO_DETAILS =
 105             "The call returns all Near-RT RICs that supports a given policy type identity";
 106
 107     /**
 108      * @return a Json array of all RIC data Example: http://localhost:8081/v2/ric
 109      */
 110     @GetMapping(path = Consts.V2_API_ROOT + "/rics", produces = MediaType.APPLICATION_JSON_VALUE)
 111     @ApiOperation(value = "Query Near-RT RIC information", notes = QUERY_RIC_INFO_DETAILS)
 112     @ApiResponses(value = { //
 113             @ApiResponse(code = 200, message = "OK", response = RicInfoList.class), //
 114             @ApiResponse(code = 404, message = "Policy type is not found", response = ErrorResponse.ErrorInfo.class)})
 115     public ResponseEntity<Object> getRics( //
 116             @ApiParam(name = Consts.POLICY_TYPE_ID_PARAM, required = false,
 117                     value = "The identity of a policy type. If given, all Near-RT RICs supporteing the policy type are returned") //
 118             @RequestParam(name = Consts.POLICY_TYPE_ID_PARAM, required = false) String supportingPolicyType) {
 119         if ((supportingPolicyType != null) && (this.types.get(supportingPolicyType) == null)) {
 120             return ErrorResponse.create("Policy type not found", HttpStatus.NOT_FOUND);
 121         }
 122
 123         List<RicInfo> result = new ArrayList<>();
 124         for (Ric ric : rics.getRics()) {
 125             if (supportingPolicyType == null || ric.isSupportingType(supportingPolicyType)) {
 126                 result.add(toRicInfo(ric));
 127             }
 128         }
 129
 130         return new ResponseEntity<>(gson.toJson(new RicInfoList(result)), HttpStatus.OK);
 131     }
 132
 133     private RicInfo.RicState toRicState(Ric.RicState state) {
 134         switch (state) {
 135             case AVAILABLE:
 136                 return RicInfo.RicState.AVAILABLE;
 137             case CONSISTENCY_CHECK:
 138                 return RicInfo.RicState.CONSISTENCY_CHECK;
 139             case SYNCHRONIZING:
 140                 return RicInfo.RicState.SYNCHRONIZING;
 141             case UNAVAILABLE:
 142                 return RicInfo.RicState.UNAVAILABLE;
 143             default:
 144                 return RicInfo.RicState.UNAVAILABLE;
 145         }
 146     }
 147
 148     private RicInfo toRicInfo(Ric ric) {
 149         return new RicInfo(ric.id(), ric.getManagedElementIds(), ric.getSupportedPolicyTypeNames(),
 150                 toRicState(ric.getState()));
 151     }
 152 }