2 * ========================LICENSE_START=================================
5 * Copyright (C) 2019 AT&T Intellectual Property
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 org.oransc.ric.plt.appmgr.client.api.HealthApi;
27 import org.oransc.ric.plt.appmgr.client.api.XappApi;
28 import org.oransc.ric.plt.appmgr.client.model.AllDeployableXapps;
29 import org.oransc.ric.plt.appmgr.client.model.AllDeployedXapps;
30 import org.oransc.ric.plt.appmgr.client.model.AllXappConfig;
31 import org.oransc.ric.plt.appmgr.client.model.ConfigValidationErrors;
32 import org.oransc.ric.plt.appmgr.client.model.XAppConfig;
33 import org.oransc.ric.plt.appmgr.client.model.Xapp;
34 import org.oransc.ric.plt.appmgr.client.model.XappDescriptor;
35 import org.oransc.ric.portal.dashboard.DashboardApplication;
36 import org.oransc.ric.portal.dashboard.DashboardConstants;
37 import org.oransc.ric.portal.dashboard.config.AppManagerApiBuilder;
38 import org.oransc.ric.portal.dashboard.model.AppTransport;
39 import org.oransc.ric.portal.dashboard.model.DashboardDeployableXapps;
40 import org.oransc.ric.portal.dashboard.model.SuccessTransport;
41 import org.slf4j.Logger;
42 import org.slf4j.LoggerFactory;
43 import org.springframework.beans.factory.annotation.Autowired;
44 import org.springframework.context.annotation.Configuration;
45 import org.springframework.http.MediaType;
46 import org.springframework.security.access.annotation.Secured;
47 import org.springframework.util.Assert;
48 import org.springframework.web.bind.annotation.DeleteMapping;
49 import org.springframework.web.bind.annotation.GetMapping;
50 import org.springframework.web.bind.annotation.PathVariable;
51 import org.springframework.web.bind.annotation.PostMapping;
52 import org.springframework.web.bind.annotation.PutMapping;
53 import org.springframework.web.bind.annotation.RequestBody;
54 import org.springframework.web.bind.annotation.RequestMapping;
55 import org.springframework.web.bind.annotation.RestController;
57 import io.swagger.annotations.ApiOperation;
60 * Proxies calls from the front end to the App Manager API.
62 * If a method throws RestClientResponseException, it is handled by
63 * {@link CustomResponseEntityExceptionHandler#handleProxyMethodException(Exception, org.springframework.web.context.request.WebRequest)}
64 * which returns status 502. All other exceptions are handled by Spring which
69 @RequestMapping(value = AppManagerController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
70 public class AppManagerController {
72 private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
74 // Publish paths in constants so tests are easy to write
75 public static final String CONTROLLER_PATH = DashboardConstants.ENDPOINT_PREFIX + "/appmgr";
76 public static final String HEALTH_ALIVE_METHOD = "health/alive";
77 public static final String HEALTH_READY_METHOD = "health/ready";
78 public static final String CONFIG_METHOD = "config";
79 public static final String XAPPS_METHOD = "xapps";
80 public static final String XAPPS_LIST_METHOD = XAPPS_METHOD + "/list";
82 public static final String PP_XAPP_NAME = "xAppName";
84 private static final String CONFIG_METHOD_PATH = DashboardConstants.RIC_INSTANCE_KEY + "/{"
85 + DashboardConstants.RIC_INSTANCE_KEY + "}/" + CONFIG_METHOD;
86 private static final String XAPPS_METHOD_PATH = DashboardConstants.RIC_INSTANCE_KEY + "/{"
87 + DashboardConstants.RIC_INSTANCE_KEY + "}/" + XAPPS_METHOD;
89 // Populated by the autowired constructor
90 private final AppManagerApiBuilder appManagerApiBuilder;
93 public AppManagerController(final AppManagerApiBuilder appManagerApiBuilder) {
94 Assert.notNull(appManagerApiBuilder, "builder must not be null");
95 this.appManagerApiBuilder = appManagerApiBuilder;
96 if (logger.isDebugEnabled())
97 logger.debug("ctor: configured with builder type {}", appManagerApiBuilder.getClass().getName());
100 @ApiOperation(value = "Gets the App manager client library MANIFEST.MF property Implementation-Version.", response = SuccessTransport.class)
101 @GetMapping(DashboardConstants.VERSION_METHOD)
103 public SuccessTransport getClientVersion() {
104 return new SuccessTransport(200, DashboardApplication.getImplementationVersion(HealthApi.class));
107 @ApiOperation(value = "Health check of App Manager - Liveness probe.")
108 @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
109 + HEALTH_ALIVE_METHOD)
111 public void getHealth(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
112 HttpServletResponse response) {
113 logger.debug("getHealthAlive instance {}", instanceKey);
114 HealthApi api = appManagerApiBuilder.getHealthApi(instanceKey);
115 api.getHealthAlive();
116 response.setStatus(api.getApiClient().getStatusCode().value());
119 @ApiOperation(value = "Readiness check of App Manager - Readiness probe.")
120 @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
121 + HEALTH_READY_METHOD)
123 public void getHealthReady(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
124 HttpServletResponse response) {
125 logger.debug("getHealthReady instance {}", instanceKey);
126 HealthApi api = appManagerApiBuilder.getHealthApi(instanceKey);
127 api.getHealthReady();
128 response.setStatus(api.getApiClient().getStatusCode().value());
131 @ApiOperation(value = "Returns the configuration of all Xapps.", response = AllXappConfig.class)
132 @GetMapping(CONFIG_METHOD_PATH)
133 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
134 public AllXappConfig getAllXappConfig(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) {
135 logger.debug("getAllXappConfig instance {}", instanceKey);
136 return appManagerApiBuilder.getXappApi(instanceKey).getAllXappConfig();
139 @ApiOperation(value = "Modify XApp config.", response = ConfigValidationErrors.class)
140 @PutMapping(CONFIG_METHOD_PATH)
141 @Secured({ DashboardConstants.ROLE_ADMIN })
142 public ConfigValidationErrors modifyXappConfig(
143 @PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey, @RequestBody XAppConfig xAppConfig) {
144 logger.debug("modifyXappConfig instance {} config {}", instanceKey, xAppConfig);
145 return appManagerApiBuilder.getXappApi(instanceKey).modifyXappConfig(xAppConfig);
148 @ApiOperation(value = "Returns a list of deployable xapps.", response = DashboardDeployableXapps.class)
149 @GetMapping(DashboardConstants.RIC_INSTANCE_KEY + "/{" + DashboardConstants.RIC_INSTANCE_KEY + "}/"
151 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
152 public DashboardDeployableXapps getAvailableXapps(
153 @PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) {
154 logger.debug("getAvailableXapps instance {}", instanceKey);
155 AllDeployableXapps deployableXapps = appManagerApiBuilder.getXappApi(instanceKey).listAllXapps();
156 // Answer a collection of structure instead of string
157 // because I expect the AppMgr to be extended with
158 // additional properties for each one.
159 DashboardDeployableXapps apps = new DashboardDeployableXapps();
160 for (String n : deployableXapps)
161 apps.add(new AppTransport(n));
165 @ApiOperation(value = "Returns the status of all deployed xapps.", response = AllDeployedXapps.class)
166 @GetMapping(XAPPS_METHOD_PATH)
167 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
168 public AllDeployedXapps getDeployedXapps(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey) {
169 logger.debug("getDeployedXapps instance {}", instanceKey);
170 return appManagerApiBuilder.getXappApi(instanceKey).getAllXapps();
173 @ApiOperation(value = "Returns the status of a given xapp.", response = Xapp.class)
174 @GetMapping(XAPPS_METHOD_PATH + "/{" + PP_XAPP_NAME + "}")
175 @Secured({ DashboardConstants.ROLE_ADMIN, DashboardConstants.ROLE_STANDARD })
176 public Xapp getXapp(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
177 @PathVariable(PP_XAPP_NAME) String appName) {
178 logger.debug("getXapp instance {} name {}", instanceKey, appName);
179 return appManagerApiBuilder.getXappApi(instanceKey).getXappByName(appName);
182 @ApiOperation(value = "Deploy a xapp.", response = Xapp.class)
183 @PostMapping(XAPPS_METHOD_PATH)
184 @Secured({ DashboardConstants.ROLE_ADMIN })
185 public Xapp deployXapp(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
186 @RequestBody XappDescriptor appDescriptor) {
187 logger.debug("deployXapp instance {} descriptor {}", instanceKey, appDescriptor);
188 return appManagerApiBuilder.getXappApi(instanceKey).deployXapp(appDescriptor);
191 @ApiOperation(value = "Undeploy an existing xapp.")
192 @DeleteMapping(XAPPS_METHOD_PATH + "/{" + PP_XAPP_NAME + "}")
193 @Secured({ DashboardConstants.ROLE_ADMIN })
194 public void undeployXapp(@PathVariable(DashboardConstants.RIC_INSTANCE_KEY) String instanceKey,
195 @PathVariable(PP_XAPP_NAME) String appName, HttpServletResponse response) {
196 logger.debug("undeployXapp instance {} name {}", instanceKey, appName);
197 XappApi api = appManagerApiBuilder.getXappApi(instanceKey);
198 api.undeployXapp(appName);
199 response.setStatus(api.getApiClient().getStatusCode().value());