dashboard/webapp-backend/src/main/java/org/oransc/ric/portal/dashboard/controller/PolicyController.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 package org.oransc.ric.portal.dashboard.controller;
  21
  22 import java.lang.invoke.MethodHandles;
  23
  24 import javax.servlet.http.HttpServletResponse;
  25
  26 import com.google.gson.Gson;
  27 import com.google.gson.GsonBuilder;
  28
  29 import org.oransc.ric.portal.dashboard.DashboardApplication;
  30 import org.oransc.ric.portal.dashboard.DashboardConstants;
  31 import org.oransc.ric.portal.dashboard.exceptions.HttpBadRequestException;
  32 import org.oransc.ric.portal.dashboard.exceptions.HttpInternalServerErrorException;
  33 import org.oransc.ric.portal.dashboard.exceptions.HttpNotFoundException;
  34 import org.oransc.ric.portal.dashboard.exceptions.HttpNotImplementedException;
  35 import org.oransc.ric.portal.dashboard.model.PolicyInstances;
  36 import org.oransc.ric.portal.dashboard.model.PolicyTypes;
  37 import org.oransc.ric.portal.dashboard.model.SuccessTransport;
  38 import org.oransc.ric.portal.dashboard.policyagentapi.PolicyAgentApi;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41 import org.springframework.beans.factory.annotation.Autowired;
  42 import org.springframework.http.HttpStatus;
  43 import org.springframework.http.MediaType;
  44 import org.springframework.security.access.annotation.Secured;
  45 import org.springframework.util.Assert;
  46 import org.springframework.web.bind.annotation.DeleteMapping;
  47 import org.springframework.web.bind.annotation.GetMapping;
  48 import org.springframework.web.bind.annotation.PathVariable;
  49 import org.springframework.web.bind.annotation.PutMapping;
  50 import org.springframework.web.bind.annotation.RequestBody;
  51 import org.springframework.web.bind.annotation.RequestMapping;
  52 import org.springframework.web.bind.annotation.RequestParam;
  53 import org.springframework.web.bind.annotation.RestController;
  54 import java.util.Collection;
  55 import io.swagger.annotations.ApiOperation;
  56
  57 /**
  58  * Proxies calls from the front end to the Policy agent API.
  59  *
  60  * If a method throws RestClientResponseException, it is handled by
  61  * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
  62  * which returns status 502. All other exceptions are handled by Spring which
  63  * returns status 500.
  64  */
  65 @RestController
  66 @RequestMapping(value = PolicyController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  67 public class PolicyController {
  68
  69         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  70         private static Gson gson = new GsonBuilder() //
  71                         .serializeNulls() //
  72                         .create(); //
  73
  74         // Publish paths in constants so tests are easy to write
  75         public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/policy";
  76         // Endpoints
  77         public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
  78         public static final String POLICY_TYPES_METHOD = "policytypes";
  79         public static final String POLICY_TYPE_ID_NAME = "policy_type_id";
  80         public static final String POLICIES_NAME = "policies";
  81         public static final String POLICY_INSTANCE_ID_NAME = "policy_instance_id";
  82
  83         // Populated by the autowired constructor
  84         private final PolicyAgentApi policyAgentApi;
  85
  86         @Autowired
  87         public PolicyController(final PolicyAgentApi policyAgentApi) {
  88                 Assert.notNull(policyAgentApi, "API must not be null");
  89                 this.policyAgentApi = policyAgentApi;
  90                 logger.debug("ctor: configured with client type {}", policyAgentApi.getClass().getName());
  91         }
  92
  93         /*
  94          * The fields are defined in the Policy Control Typescript interface.
  95          */
  96         @ApiOperation(value = "Gets the policy types from Near Realtime-RIC")
  97         @GetMapping(POLICY_TYPES_METHOD)
  98         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
  99         public PolicyTypes getAllPolicyTypes(HttpServletResponse response) {
 100                 logger.debug("getAllPolicyTypes");
 101                 return this.policyAgentApi.getAllPolicyTypes();
 102         }
 103
 104         @ApiOperation(value = "Returns the policy instances for the given policy type.")
 105         @GetMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME)
 106         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 107         public String getPolicyInstances(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString) {
 108                 logger.debug("getPolicyInstances {}", policyTypeIdString);
 109
 110                 PolicyInstances i = this.policyAgentApi.getPolicyInstancesForType(policyTypeIdString);
 111                 String json = gson.toJson(i);
 112                 return json;
 113         }
 114
 115         @ApiOperation(value = "Returns a policy instance of a type")
 116         @GetMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME
 117                         + "}")
 118         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 119         public String getPolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString,
 120                         @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId) {
 121                 logger.debug("getPolicyInstance {}:{}", policyTypeIdString, policyInstanceId);
 122                 return this.policyAgentApi.getPolicyInstance(policyInstanceId);
 123         }
 124
 125         @ApiOperation(value = "Creates the policy instances for the given policy type.")
 126         @PutMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME
 127                         + "}")
 128         @Secured({ DashboardConstants.ROLE_ADMIN })
 129         public void putPolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString,
 130                         @RequestParam(name = "ric", required = true) String ric,
 131                         @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId, @RequestBody String instance) {
 132                 logger.debug("putPolicyInstance typeId: {}, instanceId: {}, instance: {}", policyTypeIdString, policyInstanceId,
 133                                 instance);
 134                 this.policyAgentApi.putPolicy(policyTypeIdString, policyInstanceId, instance, ric);
 135         }
 136
 137         @ApiOperation(value = "Deletes the policy instances for the given policy type.")
 138         @DeleteMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{"
 139                         + POLICY_INSTANCE_ID_NAME + "}")
 140         @Secured({ DashboardConstants.ROLE_ADMIN })
 141         public void deletePolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString,
 142                         @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId) {
 143                 logger.debug("deletePolicyInstance typeId: {}, instanceId: {}", policyTypeIdString, policyInstanceId);
 144                 this.policyAgentApi.deletePolicy(policyInstanceId);
 145         }
 146
 147         private void checkHttpError(String httpCode) {
 148                 logger.debug("Http Response Code: {}", httpCode);
 149                 if (httpCode.equals(String.valueOf(HttpStatus.NOT_FOUND.value()))) {
 150                         logger.error("Caught HttpNotFoundException");
 151                         throw new HttpNotFoundException("Not Found Exception");
 152                 } else if (httpCode.equals(String.valueOf(HttpStatus.BAD_REQUEST.value()))) {
 153                         logger.error("Caught HttpBadRequestException");
 154                         throw new HttpBadRequestException("Bad Request Exception");
 155                 } else if (httpCode.equals(String.valueOf(HttpStatus.INTERNAL_SERVER_ERROR.value()))) {
 156                         logger.error("Caught HttpInternalServerErrorException");
 157                         throw new HttpInternalServerErrorException("Internal Server Error Exception");
 158                 } else if (httpCode.equals(String.valueOf(HttpStatus.NOT_IMPLEMENTED.value()))) {
 159                         logger.error("Caught HttpNotImplementedException");
 160                         throw new HttpNotImplementedException("Not Implemented Exception");
 161                 }
 162         }
 163
 164         @ApiOperation(value = "Returns the rics supporting the given policy type.")
 165         @GetMapping("/rics")
 166         @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
 167         public String getRicsSupportingType(
 168                         @RequestParam(name = "policyType", required = true) String supportingPolicyType) {
 169                 logger.debug("getRicsSupportingType {}", supportingPolicyType);
 170
 171                 Collection<String> result = this.policyAgentApi.getRicsSupportingType(supportingPolicyType);
 172                 String json = gson.toJson(result);
 173                 return json;
 174         }
 175
 176 };