2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 Nordix Foundation
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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===================================
20 package org.oransc.ric.portal.dashboard.controller;
22 import java.lang.invoke.MethodHandles;
24 import javax.servlet.http.HttpServletResponse;
26 import com.google.gson.Gson;
27 import com.google.gson.GsonBuilder;
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.RestController;
54 import io.swagger.annotations.ApiOperation;
57 * Proxies calls from the front end to the Policy agent API.
59 * If a method throws RestClientResponseException, it is handled by
60 * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
61 * which returns status 502. All other exceptions are handled by Spring which
65 @RequestMapping(value = PolicyController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
66 public class PolicyController {
68 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
69 private static Gson gson = new GsonBuilder() //
73 // Publish paths in constants so tests are easy to write
74 public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/policy";
76 public static final String VERSION_METHOD = DashboardConstants.VERSION_METHOD;
77 public static final String POLICY_TYPES_METHOD = "policytypes";
78 public static final String POLICY_TYPE_ID_NAME = "policy_type_id";
79 public static final String POLICIES_NAME = "policies";
80 public static final String POLICY_INSTANCE_ID_NAME = "policy_instance_id";
82 // Populated by the autowired constructor
83 private final PolicyAgentApi policyAgentApi;
86 public PolicyController(final PolicyAgentApi policyAgentApi) {
87 Assert.notNull(policyAgentApi, "API must not be null");
88 this.policyAgentApi = policyAgentApi;
89 logger.debug("ctor: configured with client type {}", policyAgentApi.getClass().getName());
93 * The fields are defined in the Policy Control Typescript interface.
95 @ApiOperation(value = "Gets the policy types from Near Realtime-RIC")
96 @GetMapping(POLICY_TYPES_METHOD)
97 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
98 public PolicyTypes getAllPolicyTypes(HttpServletResponse response) {
99 logger.debug("getAllPolicyTypes");
100 return this.policyAgentApi.getAllPolicyTypes();
103 @ApiOperation(value = "Returns the policy instances for the given policy type.")
104 @GetMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME)
105 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
106 public String getPolicyInstances(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString) {
107 logger.debug("getPolicyInstances {}", policyTypeIdString);
109 PolicyInstances i = this.policyAgentApi.getPolicyInstancesForType(policyTypeIdString);
110 String json = gson.toJson(i);
114 @ApiOperation(value = "Returns a policy instance of a type")
115 @GetMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME
117 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
118 public String getPolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString,
119 @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId) {
120 logger.debug("getPolicyInstance {}:{}", policyTypeIdString, policyInstanceId);
121 return this.policyAgentApi.getPolicyInstance(policyInstanceId);
124 @ApiOperation(value = "Creates the policy instances for the given policy type.")
125 @PutMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME
127 @Secured({ DashboardConstants.ROLE_ADMIN })
128 public void putPolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString,
129 @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId, @RequestBody String instance) {
130 logger.debug("putPolicyInstance typeId: {}, instanceId: {}, instance: {}", policyTypeIdString, policyInstanceId,
132 this.policyAgentApi.putPolicy(policyTypeIdString, policyInstanceId, instance);
135 @ApiOperation(value = "Deletes the policy instances for the given policy type.")
136 @DeleteMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{"
137 + POLICY_INSTANCE_ID_NAME + "}")
138 @Secured({ DashboardConstants.ROLE_ADMIN })
139 public void deletePolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString,
140 @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId) {
141 logger.debug("deletePolicyInstance typeId: {}, instanceId: {}", policyTypeIdString, policyInstanceId);
142 this.policyAgentApi.deletePolicy(policyInstanceId);
145 private void checkHttpError(String httpCode) {
146 logger.debug("Http Response Code: {}", httpCode);
147 if (httpCode.equals(String.valueOf(HttpStatus.NOT_FOUND.value()))) {
148 logger.error("Caught HttpNotFoundException");
149 throw new HttpNotFoundException("Not Found Exception");
150 } else if (httpCode.equals(String.valueOf(HttpStatus.BAD_REQUEST.value()))) {
151 logger.error("Caught HttpBadRequestException");
152 throw new HttpBadRequestException("Bad Request Exception");
153 } else if (httpCode.equals(String.valueOf(HttpStatus.INTERNAL_SERVER_ERROR.value()))) {
154 logger.error("Caught HttpInternalServerErrorException");
155 throw new HttpInternalServerErrorException("Internal Server Error Exception");
156 } else if (httpCode.equals(String.valueOf(HttpStatus.NOT_IMPLEMENTED.value()))) {
157 logger.error("Caught HttpNotImplementedException");
158 throw new HttpNotImplementedException("Not Implemented Exception");