From: elinuxhenrik Date: Mon, 30 Mar 2020 06:53:58 +0000 (+0200) Subject: Correct spelling mistake in name of component X-Git-Tag: BronzeRC0~18 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=22cfc3d48f2c8fdd395d820d623c11924af960f8;p=portal%2Fnonrtric-controlpanel.git Correct spelling mistake in name of component Name should be Control Panel, not Controlpanel. Change-Id: Icbb222cb0136ce9dff9efaf97d396e5673e323e0 Issue-ID: NONRTRIC-166 Signed-off-by: elinuxhenrik --- diff --git a/README.md b/README.md index d5771d1..bd0ff26 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# O-RAN-SC NonRT RIC Controlpanel Web Application +# O-RAN-SC NonRT RIC Control Panel Web Application -The O-RAN Non-RT RIC Controlpanel provides administrative and operator functions for a Near-RT RIC through the A1 API. +The O-RAN Non-RT RIC Control Panel provides administrative and operator functions for a Near-RT RIC through the A1 API. This web app consists of an Angular (version 8) front end and a Java (version 11) Spring-Boot (version 2.1) back end. diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 2995872..8dc48fb 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -4,17 +4,17 @@ Developer Guide =============== -This document provides a quickstart for developers of the Non-RT RIC Controlpanel. +This document provides a quickstart for developers of the Non-RT RIC Control Panel. -The Non-RT RIC Controlpanel is an interface that allows human users to create, edit and delete policy instances, for +The Non-RT RIC Control Panel is an interface that allows human users to create, edit and delete policy instances, for each existing policy type. The policy types and their definitions are retrieved from each Near-RT RIC. See the README.md file in the nonrtric-controlpanel repo for info about how to use it. -Start the Controlpanel for development -====================================== +Start the Control Panel for development +======================================= -To run the control panel locally for development with simulated services, follow these steps: +To run the Control Panel locally for development with simulated services, follow these steps: - Fetch the latest code from `gerrit`_ @@ -26,7 +26,7 @@ To run the control panel locally for development with simulated services, follow mvn clean install - mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=ControlpanelTestServer -DfailIfNoTests=false test + mvn -Dorg.oransc.portal.nonrtric.controlpanel=mock -Dtest=ControlPanelTestServer -DfailIfNoTests=false test - Now you can open URL: `localhost:8080`_ in a browser to access the backend directly. @@ -39,7 +39,7 @@ Start the frontend: ./ng serve --proxy-config proxy.conf.json -- Now you can open URL: `localhost:4200`_ in a browser to access the Controlpanel. +- Now you can open URL: `localhost:4200`_ in a browser to access the Control Panel. .. _localhost:4200: localhost:4200 diff --git a/docs/images/non-RT_RIC_controlpanel.png b/docs/images/non-RT_RIC_controlpanel.png index 32f07bf..7d28f45 100644 Binary files a/docs/images/non-RT_RIC_controlpanel.png and b/docs/images/non-RT_RIC_controlpanel.png differ diff --git a/docs/index.rst b/docs/index.rst index e59e017..92a6555 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,10 +2,8 @@ .. SPDX-License-Identifier: CC-BY-4.0 -Non-RT RIC Controlpanel -======================= - -.. Add or remove sections below as appropriate for the platform component. +Non-RT RIC Control Panel +======================== .. toctree:: :maxdepth: 2 diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index d7df04e..ff1bbd2 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -13,9 +13,9 @@ Installation Guide Abstract -------- -This document describes how to install the Non-RT RIC Controlpanel, its dependencies and required system resources. +This document describes how to install the Non-RT RIC Control Panel, its dependencies and required system resources. -This work is in progress. For now, it is possible to use the Non-RT RIC Controlpanel. +This work is in progress. For now, it is possible to use the Non-RT RIC Control Panel. Version history diff --git a/docs/overview.rst b/docs/overview.rst index e2040ac..170fd93 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -2,23 +2,23 @@ .. SPDX-License-Identifier: CC-BY-4.0 -Controlpanel Overview -===================== +Control Panel Overview +====================== -The Non-RT RIC Controlpanel is a graphical user user interface that enables the user to manage the Policies in the -network. The Controlpanel interacts with the Policy agent via a REST API. -The Controlpanel generates its GUI from JSON schemas in a model driven fashion. +The Non-RT RIC Control Panel is a graphical user user interface that enables the user to manage the Policies in the +network. The Control Panel interacts with the Policy agent via a REST API. +The Control Panel generates its GUI from JSON schemas in a model driven fashion. -The Controlpanel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the +The Control Panel consists of a back end implemented as a Java Spring Boot application and a fronted developed using the Angular framework. -Controlpanel architecture -------------------------- +Control Panel architecture +-------------------------- -The architecture of the Controlpanel is as shown on the following picture: +The architecture of the Control Panel is as shown on the following picture: .. image:: ./images/architecture.png :scale: 50 % -The Controlpanel itself is split into the backend and the frontend, and can be deployed following the instructions in +The Control Panel itself is split into the backend and the frontend, and can be deployed following the instructions in the README.md file in the repo. \ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 71696a9..a075163 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -6,7 +6,7 @@ Release-Notes ============= -This document provides the release notes for the release of the Non-RT RIC Controlpanel. +This document provides the release notes for the release of the Non-RT RIC Control Panel. .. contents:: :depth: 3 @@ -37,7 +37,7 @@ Release Data Bronze ------ +--------------------------------------+--------------------------------------------------+ -| **Project** | Non-RT RIC Controlpanel | +| **Project** | Non-RT RIC Control Panel | | | | +--------------------------------------+--------------------------------------------------+ | **Repo/commit-ID** | | @@ -49,6 +49,6 @@ Bronze | **Release date** | | | | | +--------------------------------------+--------------------------------------------------+ -| **Purpose of the delivery** | Introducing Non-RT RIC Controlpanel | +| **Purpose of the delivery** | Introducing Non-RT RIC Control Panel | | | | +--------------------------------------+--------------------------------------------------+ diff --git a/pom.xml b/pom.xml index 868f8f5..c95b41c 100644 --- a/pom.xml +++ b/pom.xml @@ -32,7 +32,7 @@ limitations under the License. org.o-ran-sc.portal.nonrtric.controlpanel nonrtric-controlpanel-parent - Non-RT RIC Controlpanel project + Non-RT RIC Control Panel project pom 1.0.0-SNAPSHOT diff --git a/webapp-backend/README.md b/webapp-backend/README.md index 4867adc..acec8ac 100644 --- a/webapp-backend/README.md +++ b/webapp-backend/README.md @@ -1,6 +1,6 @@ -# Non-RT RIC Controlpanel Web Application Backend +# Non-RT RIC Control Panel Web Application Backend -The Non-RT RIC Controlpanel back-end provides REST services to the Controlpanel +The Non-RT RIC Control Panel back-end provides REST services to the Control Panel front-end Typescript features running in the user's browser. For production use, it also serves the Angular application files. diff --git a/webapp-backend/config/key.properties.template b/webapp-backend/config/key.properties.template index 74e7727..ecf8b94 100644 --- a/webapp-backend/config/key.properties.template +++ b/webapp-backend/config/key.properties.template @@ -16,6 +16,6 @@ # limitations under the License. # ========================LICENSE_END=================================== -# Template for the file that provides a secret key for the Non-RT RIC Controlpanel. +# Template for the file that provides a secret key for the Non-RT RIC Control Panel. cipher.enc.key = diff --git a/webapp-backend/pom.xml b/webapp-backend/pom.xml index e7ca3ad..ff92311 100644 --- a/webapp-backend/pom.xml +++ b/webapp-backend/pom.xml @@ -33,7 +33,7 @@ limitations under the License. 1.0.0-SNAPSHOT nonrtric-controlpanel-be - Non-RT RIC Controlpanel Webapp backend + Non-RT RIC Control Panel Webapp backend 2.6.0 2.9.2 @@ -327,7 +327,7 @@ limitations under the License. -Xmx256m -cp maven:maven/${project.artifactId}-${project.version}.${project.packaging} - -Dloader.main=org.oransc.portal.nonrtric.controlpanel.ControlpanelApplication + -Dloader.main=org.oransc.portal.nonrtric.controlpanel.ControlPanelApplication -Djava.security.egd=file:/dev/./urandom org.springframework.boot.loader.PropertiesLauncher diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelApplication.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelApplication.java similarity index 95% rename from webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelApplication.java rename to webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelApplication.java index 76bb8bc..dee84ad 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelApplication.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelApplication.java @@ -32,12 +32,12 @@ import org.springframework.context.annotation.ComponentScan; @SpringBootApplication // Limit scan to controlpanel classes; exclude generated API classes @ComponentScan("org.oransc.portal.nonrtric.controlpanel") -public class ControlpanelApplication { +public class ControlPanelApplication { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); public static void main(String[] args) { - SpringApplication.run(ControlpanelApplication.class); + SpringApplication.run(ControlPanelApplication.class); // Ensure this appears on the console by using level WARN logger.warn("main: version '{}' successful start", getImplementationVersion(MethodHandles.lookup().lookupClass())); diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelConstants.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelConstants.java similarity index 95% rename from webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelConstants.java rename to webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelConstants.java index 913f803..2e2d87e 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelConstants.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelConstants.java @@ -20,9 +20,9 @@ */ package org.oransc.portal.nonrtric.controlpanel; -public abstract class ControlpanelConstants { +public abstract class ControlPanelConstants { - private ControlpanelConstants() { + private ControlPanelConstants() { // Sonar insists on hiding the constructor } diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelUserManager.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelUserManager.java similarity index 94% rename from webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelUserManager.java rename to webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelUserManager.java index 663526b..ba42b03 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelUserManager.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelUserManager.java @@ -43,7 +43,7 @@ import org.slf4j.LoggerFactory; * * This first implementation serializes user details to a file. */ -public class ControlpanelUserManager { +public class ControlPanelUserManager { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); @@ -62,11 +62,11 @@ public class ControlpanelUserManager { * @throws IOException * On file error */ - public ControlpanelUserManager(boolean clear) throws IOException { + public ControlPanelUserManager(boolean clear) throws IOException { this(USER_FILE_PATH); if (clear) { logger.debug("ctor: removing file {}", userFile.getAbsolutePath()); - File f = new File(ControlpanelUserManager.USER_FILE_PATH); + File f = new File(ControlPanelUserManager.USER_FILE_PATH); if (f.exists()) Files.delete(f.toPath()); users.clear(); @@ -81,7 +81,7 @@ public class ControlpanelUserManager { * @throws IOException * If file cannot be read */ - public ControlpanelUserManager(final String userFilePath) throws IOException { + public ControlPanelUserManager(final String userFilePath) throws IOException { logger.debug("ctor: userfile {}", userFilePath); if (userFilePath == null) throw new IllegalArgumentException("Missing or empty user file property"); @@ -164,7 +164,7 @@ public class ControlpanelUserManager { // Test infrastructure public static void main(String[] args) throws Exception { - ControlpanelUserManager dum = new ControlpanelUserManager(false); + ControlPanelUserManager dum = new ControlPanelUserManager(false); EcompUser user = new EcompUser(); user.setActive(true); user.setLoginId("demo"); @@ -172,7 +172,7 @@ public class ControlpanelUserManager { user.setLastName("Last"); EcompRole role = new EcompRole(); role.setId(1L); - role.setName(ControlpanelConstants.ROLE_NAME_ADMIN); + role.setName(ControlPanelConstants.ROLE_NAME_ADMIN); Set roles = new HashSet<>(); roles.add(role); user.setRoles(roles); diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/AdminConfiguration.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/AdminConfiguration.java index 224d0a9..836f462 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/AdminConfiguration.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/AdminConfiguration.java @@ -22,7 +22,7 @@ package org.oransc.portal.nonrtric.controlpanel.config; import java.io.IOException; import java.lang.invoke.MethodHandles; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelUserManager; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelUserManager; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; @@ -51,8 +51,8 @@ public class AdminConfiguration { @Bean // The bean (method) name must be globally unique - public ControlpanelUserManager userManager() throws IOException { - return new ControlpanelUserManager(userfile); + public ControlPanelUserManager userManager() throws IOException { + return new ControlPanelUserManager(userfile); } } diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/SwaggerConfiguration.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/SwaggerConfiguration.java index b0184d4..fa00b2f 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/SwaggerConfiguration.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/SwaggerConfiguration.java @@ -21,7 +21,7 @@ package org.oransc.portal.nonrtric.controlpanel.config; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelApplication; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelApplication; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @@ -47,19 +47,19 @@ public class SwaggerConfiguration { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2).select() // - .apis(RequestHandlerSelectors.basePackage(ControlpanelApplication.class.getPackage().getName())) // + .apis(RequestHandlerSelectors.basePackage(ControlPanelApplication.class.getPackage().getName())) // .paths(PathSelectors.any()) // .build() // .apiInfo(apiInfo()); } private ApiInfo apiInfo() { - final String version = ControlpanelApplication.class.getPackage().getImplementationVersion(); + final String version = ControlPanelApplication.class.getPackage().getImplementationVersion(); return new ApiInfoBuilder() // - .title("Non-RT RIC Controlpanel backend") // + .title("Non-RT RIC Control Panel backend") // .description("Proxies access to Near-RT RIC.")// .termsOfServiceUrl("Terms of service") // - .contact(new Contact("Non-RT RIC Controlpanel Dev Team", // + .contact(new Contact("Non-RT RIC Control Panel Dev Team", // "http://no-docs-yet.org/", // "noreply@O-RAN-SC.org")) // .license("Apache 2.0 License").licenseUrl("http://www.apache.org/licenses/LICENSE-2.0") // diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityConfiguration.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityConfiguration.java index 4b65958..d8c2b94 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityConfiguration.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityConfiguration.java @@ -25,7 +25,7 @@ import java.lang.invoke.MethodHandles; import java.lang.reflect.InvocationTargetException; import org.onap.portalsdk.core.onboarding.util.PortalApiConstants; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelUserManager; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelUserManager; import org.oransc.portal.nonrtric.controlpanel.controller.PolicyController; import org.oransc.portal.nonrtric.controlpanel.controller.SimpleErrorController; import org.oransc.portal.nonrtric.controlpanel.portalapi.PortalAuthManager; @@ -69,7 +69,7 @@ public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter { private String userCookie; @Autowired - ControlpanelUserManager userManager; + ControlPanelUserManager userManager; @Override protected void configure(HttpSecurity http) throws Exception { diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/controller/PolicyController.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/controller/PolicyController.java index 3d08135..6f3421b 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/controller/PolicyController.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/controller/PolicyController.java @@ -25,7 +25,7 @@ import io.swagger.annotations.ApiOperation; import java.lang.invoke.MethodHandles; import javax.servlet.http.HttpServletResponse; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelConstants; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelConstants; import org.oransc.portal.nonrtric.controlpanel.policyagentapi.PolicyAgentApi; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -58,9 +58,9 @@ public class PolicyController { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); // Publish paths in constants so tests are easy to write - public static final String CONTROLLER_PATH = ControlpanelConstants.ENDPOINT_PREFIX + "/policy"; + public static final String CONTROLLER_PATH = ControlPanelConstants.ENDPOINT_PREFIX + "/policy"; // Endpoints - public static final String VERSION_METHOD = ControlpanelConstants.VERSION_METHOD; + public static final String VERSION_METHOD = ControlPanelConstants.VERSION_METHOD; public static final String POLICY_TYPES_METHOD = "policytypes"; public static final String POLICY_TYPE_ID_NAME = "policy_type_id"; public static final String POLICIES_NAME = "policies"; @@ -81,7 +81,7 @@ public class PolicyController { */ @ApiOperation(value = "Gets the policy types from Near Realtime-RIC") @GetMapping(POLICY_TYPES_METHOD) - @Secured({ControlpanelConstants.ROLE_ADMIN, ControlpanelConstants.ROLE_STANDARD}) + @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD}) public ResponseEntity getAllPolicyTypes(HttpServletResponse response) { logger.debug("getAllPolicyTypes"); return this.policyAgentApi.getAllPolicyTypes(); @@ -89,7 +89,7 @@ public class PolicyController { @ApiOperation(value = "Returns the policy instances for the given policy type.") @GetMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME) - @Secured({ControlpanelConstants.ROLE_ADMIN, ControlpanelConstants.ROLE_STANDARD}) + @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD}) public ResponseEntity getPolicyInstances(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString) { logger.debug("getPolicyInstances {}", policyTypeIdString); return this.policyAgentApi.getPolicyInstancesForType(policyTypeIdString); @@ -98,7 +98,7 @@ public class PolicyController { @ApiOperation(value = "Returns a policy instance of a type") @GetMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME + "}") - @Secured({ControlpanelConstants.ROLE_ADMIN, ControlpanelConstants.ROLE_STANDARD}) + @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD}) public ResponseEntity getPolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString, @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId) { logger.debug("getPolicyInstance {}:{}", policyTypeIdString, policyInstanceId); @@ -108,7 +108,7 @@ public class PolicyController { @ApiOperation(value = "Creates the policy instances for the given policy type.") @PutMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME + "}") - @Secured({ControlpanelConstants.ROLE_ADMIN}) + @Secured({ControlPanelConstants.ROLE_ADMIN}) public ResponseEntity putPolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString, @RequestParam(name = "ric", required = true) String ric, @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId, @RequestBody String instance) { @@ -120,7 +120,7 @@ public class PolicyController { @ApiOperation(value = "Deletes the policy instances for the given policy type.") @DeleteMapping(POLICY_TYPES_METHOD + "/{" + POLICY_TYPE_ID_NAME + "}/" + POLICIES_NAME + "/{" + POLICY_INSTANCE_ID_NAME + "}") - @Secured({ControlpanelConstants.ROLE_ADMIN}) + @Secured({ControlPanelConstants.ROLE_ADMIN}) public ResponseEntity deletePolicyInstance(@PathVariable(POLICY_TYPE_ID_NAME) String policyTypeIdString, @PathVariable(POLICY_INSTANCE_ID_NAME) String policyInstanceId) { logger.debug("deletePolicyInstance typeId: {}, instanceId: {}", policyTypeIdString, policyInstanceId); @@ -129,7 +129,7 @@ public class PolicyController { @ApiOperation(value = "Returns the rics supporting the given policy type.") @GetMapping("/rics") - @Secured({ControlpanelConstants.ROLE_ADMIN, ControlpanelConstants.ROLE_STANDARD}) + @Secured({ControlPanelConstants.ROLE_ADMIN, ControlPanelConstants.ROLE_STANDARD}) public ResponseEntity getRicsSupportingType( @RequestParam(name = "policyType", required = true) String supportingPolicyType) { logger.debug("getRicsSupportingType {}", supportingPolicyType); diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/ErrorTransport.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/ErrorTransport.java index efe2884..9646b1d 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/ErrorTransport.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/ErrorTransport.java @@ -27,7 +27,7 @@ import java.time.Instant; * This mimics the model Spring-Boot uses for a message returned on failure, to * be serialized as JSON. */ -public class ErrorTransport implements IControlpanelResponse { +public class ErrorTransport implements IControlPanelResponse { private Instant timestamp; private Integer status; diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/IControlpanelResponse.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/IControlPanelResponse.java similarity index 95% rename from webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/IControlpanelResponse.java rename to webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/IControlPanelResponse.java index 3fd5575..377e097 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/IControlpanelResponse.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/IControlPanelResponse.java @@ -23,6 +23,6 @@ package org.oransc.portal.nonrtric.controlpanel.model; /** * Marker interface used by all transport models. */ -public interface IControlpanelResponse { +public interface IControlPanelResponse { } diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/SuccessTransport.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/SuccessTransport.java index 83403c3..3e2fd7b 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/SuccessTransport.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/model/SuccessTransport.java @@ -20,7 +20,7 @@ */ package org.oransc.portal.nonrtric.controlpanel.model; -public class SuccessTransport implements IControlpanelResponse { +public class SuccessTransport implements IControlPanelResponse { private int status; private Object data; diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthenticationFilter.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthenticationFilter.java index 6a0e4c5..f9a9674 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthenticationFilter.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthenticationFilter.java @@ -42,8 +42,8 @@ import org.onap.portalsdk.core.onboarding.util.PortalApiConstants; import org.onap.portalsdk.core.onboarding.util.PortalApiProperties; import org.onap.portalsdk.core.restful.domain.EcompRole; import org.onap.portalsdk.core.restful.domain.EcompUser; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelConstants; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelUserManager; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelConstants; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelUserManager; import org.oransc.portal.nonrtric.controlpanel.model.EcompUserDetails; import org.owasp.esapi.reference.DefaultSecurityConfiguration; import org.slf4j.Logger; @@ -92,10 +92,10 @@ public class PortalAuthenticationFilter implements Filter { private final boolean enforcePortalSecurity; private final PortalAuthManager authManager; - private final ControlpanelUserManager userManager; + private final ControlPanelUserManager userManager; public PortalAuthenticationFilter(boolean portalSecurity, PortalAuthManager authManager, - ControlpanelUserManager userManager) throws IOException { + ControlPanelUserManager userManager) throws IOException { this.enforcePortalSecurity = portalSecurity; this.authManager = authManager; this.userManager = userManager; @@ -159,7 +159,7 @@ public class PortalAuthenticationFilter implements Filter { } EcompRole admin = new EcompRole(); admin.setId(1L); - admin.setName(ControlpanelConstants.ROLE_ADMIN); + admin.setName(ControlPanelConstants.ROLE_ADMIN); HashSet roles = new HashSet<>(); roles.add(admin); EcompUser user = new EcompUser(); @@ -230,7 +230,7 @@ public class PortalAuthenticationFilter implements Filter { System.getProperty("line.separator"), // "", // "", // - "Non-RT RIC Controlpanel", // + "Non-RT RIC Control Panel", // "", // "", // "", // - "

Non-RT RIC Controlpanel

", // + "

Non-RT RIC Control Panel

", // "

Please log in.

", // "

", // aHref, "Click here to authenticate at the ONAP Portal", // diff --git a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalRestCentralServiceImpl.java b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalRestCentralServiceImpl.java index ea97b1c..75ab13a 100644 --- a/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalRestCentralServiceImpl.java +++ b/webapp-backend/src/main/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalRestCentralServiceImpl.java @@ -29,7 +29,7 @@ import javax.servlet.http.HttpServletRequest; import org.onap.portalsdk.core.onboarding.crossapi.IPortalRestCentralService; import org.onap.portalsdk.core.onboarding.exception.PortalAPIException; import org.onap.portalsdk.core.restful.domain.EcompUser; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelUserManager; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelUserManager; import org.oransc.portal.nonrtric.controlpanel.config.SpringContextCache; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -52,12 +52,12 @@ public class PortalRestCentralServiceImpl implements IPortalRestCentralService { @Autowired private SpringContextCache springContextCache; private final PortalAuthManager authManager; - private final ControlpanelUserManager userManager; + private final ControlPanelUserManager userManager; public PortalRestCentralServiceImpl() throws IOException, PortalAPIException { final ApplicationContext context = springContextCache.getApplicationContext(); authManager = context.getBean(PortalAuthManager.class); - userManager = context.getBean(ControlpanelUserManager.class); + userManager = context.getBean(ControlPanelUserManager.class); } /* diff --git a/webapp-backend/src/main/resources/application.properties b/webapp-backend/src/main/resources/application.properties index 64866be..8fee6f8 100644 --- a/webapp-backend/src/main/resources/application.properties +++ b/webapp-backend/src/main/resources/application.properties @@ -17,7 +17,7 @@ # limitations under the License. # ========================LICENSE_END=================================== -# Defines Non-RT RIC Controlpanel property keys and default values. +# Defines Non-RT RIC Control Panel property keys and default values. # Create a copy in the launch directory to override values; or # copy to "application-abc.properties" as mentioned in the README. @@ -37,7 +37,7 @@ portalapi.decryptor = org.oransc.portal.nonrtric.controlpanel.portalapi.PortalSd portalapi.usercookie = UserId # portal credentials must be supplied at deployment time -portalapi.appname = Non-RT RIC Controlpanel +portalapi.appname = Non-RT RIC Control Panel portalapi.username = portalapi.password = diff --git a/webapp-backend/src/main/resources/static/error.html b/webapp-backend/src/main/resources/static/error.html index c786381..c09d1aa 100644 --- a/webapp-backend/src/main/resources/static/error.html +++ b/webapp-backend/src/main/resources/static/error.html @@ -29,7 +29,7 @@ html, body { -

Non-RT RIC Controlpanel Error

+

Non-RT RIC Control Panel Error

The previous request could not be processed.

Click here to reload the application diff --git a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelTestServer.java b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelTestServer.java similarity index 98% rename from webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelTestServer.java rename to webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelTestServer.java index fdd8103..ea832ee 100644 --- a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelTestServer.java +++ b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelTestServer.java @@ -46,7 +46,7 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; */ @ExtendWith(SpringExtension.class) @SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT) -public class ControlpanelTestServer { +public class ControlPanelTestServer { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); diff --git a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelUserManagerTest.java b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelUserManagerTest.java similarity index 90% rename from webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelUserManagerTest.java rename to webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelUserManagerTest.java index 034a154..00686eb 100644 --- a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlpanelUserManagerTest.java +++ b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/ControlPanelUserManagerTest.java @@ -29,14 +29,14 @@ import org.junit.jupiter.api.Test; import org.onap.portalsdk.core.onboarding.exception.PortalAPIException; import org.onap.portalsdk.core.restful.domain.EcompRole; import org.onap.portalsdk.core.restful.domain.EcompUser; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelConstants; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelUserManager; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelConstants; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelUserManager; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.test.context.ActiveProfiles; @ActiveProfiles("test") -public class ControlpanelUserManagerTest { +public class ControlPanelUserManagerTest { private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); @@ -48,7 +48,7 @@ public class ControlpanelUserManagerTest { user.setLastName("Last"); EcompRole role = new EcompRole(); role.setId(1L); - role.setName(ControlpanelConstants.ROLE_NAME_ADMIN); + role.setName(ControlPanelConstants.ROLE_NAME_ADMIN); Set roles = new HashSet<>(); roles.add(role); user.setRoles(roles); @@ -58,7 +58,7 @@ public class ControlpanelUserManagerTest { @Test public void testUserMgr() throws Exception { final String loginId = "demo"; - ControlpanelUserManager dum = new ControlpanelUserManager(true); + ControlPanelUserManager dum = new ControlPanelUserManager(true); EcompUser user = createEcompUser(loginId); dum.createUser(user); logger.info("Created user {}", user); diff --git a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityMockConfiguration.java b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityMockConfiguration.java index e72fd1c..e4007e3 100644 --- a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityMockConfiguration.java +++ b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/config/WebSecurityMockConfiguration.java @@ -21,7 +21,7 @@ package org.oransc.portal.nonrtric.controlpanel.config; import java.lang.invoke.MethodHandles; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelConstants; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelConstants; import org.oransc.portal.nonrtric.controlpanel.config.WebSecurityConfiguration; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -60,12 +60,12 @@ public class WebSecurityMockConfiguration extends WebSecurityConfigurerAdapter { // The admin user has the admin AND standard roles .withUser(TEST_CRED_ADMIN) // .password(encoder.encode(TEST_CRED_ADMIN)) - .roles(ControlpanelConstants.ROLE_NAME_ADMIN, ControlpanelConstants.ROLE_NAME_STANDARD)// + .roles(ControlPanelConstants.ROLE_NAME_ADMIN, ControlPanelConstants.ROLE_NAME_STANDARD)// .and()// // The standard user has only the standard role .withUser(TEST_CRED_STANDARD) // .password(encoder.encode(TEST_CRED_STANDARD)) // - .roles(ControlpanelConstants.ROLE_NAME_STANDARD); + .roles(ControlPanelConstants.ROLE_NAME_STANDARD); } @Override diff --git a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/controller/PortalRestCentralServiceTest.java b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/controller/PortalRestCentralServiceTest.java index 77038b6..a09f693 100644 --- a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/controller/PortalRestCentralServiceTest.java +++ b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/controller/PortalRestCentralServiceTest.java @@ -72,7 +72,7 @@ public class PortalRestCentralServiceTest extends AbstractControllerTest { * EcompRole role = new EcompRole(); * role.setRoleFunctions(Collections.EMPTY_SET); * role.setId(1L); - * role.setName(ControlpanelConstants.ROLE_NAME_ADMIN); + * role.setName(ControlPanelConstants.ROLE_NAME_ADMIN); * Set roles = new HashSet<>(); * roles.add(role); * user.setRoles(roles); diff --git a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthManagerTest.java b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthManagerTest.java index cdb78f1..55637d2 100644 --- a/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthManagerTest.java +++ b/webapp-backend/src/test/java/org/oransc/portal/nonrtric/controlpanel/portalapi/PortalAuthManagerTest.java @@ -31,7 +31,7 @@ import org.junit.Assert; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.onap.portalsdk.core.onboarding.util.PortalApiConstants; -import org.oransc.portal.nonrtric.controlpanel.ControlpanelUserManager; +import org.oransc.portal.nonrtric.controlpanel.ControlPanelUserManager; import org.oransc.portal.nonrtric.controlpanel.portalapi.PortalAuthManager; import org.oransc.portal.nonrtric.controlpanel.portalapi.PortalAuthenticationFilter; import org.slf4j.Logger; @@ -73,7 +73,7 @@ public class PortalAuthManagerTest { logger.debug("validateEcompSso answers {}", s); Assert.assertNull(s); - ControlpanelUserManager dum = new ControlpanelUserManager(true); + ControlPanelUserManager dum = new ControlPanelUserManager(true); PortalAuthenticationFilter filter = new PortalAuthenticationFilter(false, m, dum); filter.init(null); filter.destroy(); diff --git a/webapp-frontend/README.md b/webapp-frontend/README.md index fce6e33..1360dd3 100644 --- a/webapp-frontend/README.md +++ b/webapp-frontend/README.md @@ -1,4 +1,4 @@ -# Non-RT RIC Controlpanel Web Application Frontend +# Non-RT RIC Control Panel Web Application Frontend This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 7.2.3. diff --git a/webapp-frontend/pom.xml b/webapp-frontend/pom.xml index 6dfa858..b12bbd1 100644 --- a/webapp-frontend/pom.xml +++ b/webapp-frontend/pom.xml @@ -29,7 +29,7 @@ limitations under the License. 1.0.0-SNAPSHOT nonrtric-controlpanel-fe - Non-RT RIC Controlpanel Webapp frontend + Non-RT RIC Control Panel Webapp frontend diff --git a/webapp-frontend/src/app/controlpanel.component.html b/webapp-frontend/src/app/controlpanel.component.html index bc7a835..3ba12a6 100644 --- a/webapp-frontend/src/app/controlpanel.component.html +++ b/webapp-frontend/src/app/controlpanel.component.html @@ -33,10 +33,10 @@ class="hamburger__icon__fill" data-name="Rectangle 11" rx="2" transform="translate(31.5 30)" /> - + - Non-RT RIC Controlpanel + Non-RT RIC Control Panel @@ -74,10 +74,10 @@ class="hamburger__icon__fill" data-name="Rectangle 11" rx="2" transform="translate(31.5 30)" /> - + - Non-RT RIC Controlpanel + Non-RT RIC Control Panel diff --git a/webapp-frontend/src/app/controlpanel.component.scss b/webapp-frontend/src/app/controlpanel.component.scss index ddefe09..86dab8e 100644 --- a/webapp-frontend/src/app/controlpanel.component.scss +++ b/webapp-frontend/src/app/controlpanel.component.scss @@ -233,7 +233,7 @@ mat-drawer-content { .mode-toggle__bg { height: 1rem; - width: 2rem; + width: 2.7rem; border-radius: 0.5rem; background-color: rgba(0, 0, 0, 0.5); display: inline-block; diff --git a/webapp-frontend/src/app/interfaces/controlpanel.types.ts b/webapp-frontend/src/app/interfaces/controlpanel.types.ts index ec6e5c8..44e1d9f 100644 --- a/webapp-frontend/src/app/interfaces/controlpanel.types.ts +++ b/webapp-frontend/src/app/interfaces/controlpanel.types.ts @@ -19,7 +19,7 @@ * ========================LICENSE_END=================================== */ -// Models of data used by Controlpanel admin services +// Models of data used by Control Panel admin services export interface ControlpanelSuccessTransport { status: number; diff --git a/webapp-frontend/src/app/services/caas-ingress/caas-ingress.service.ts b/webapp-frontend/src/app/services/caas-ingress/caas-ingress.service.ts index 9f3a03b..6663fa5 100644 --- a/webapp-frontend/src/app/services/caas-ingress/caas-ingress.service.ts +++ b/webapp-frontend/src/app/services/caas-ingress/caas-ingress.service.ts @@ -24,7 +24,7 @@ import { V1PodList } from '@kubernetes/client-node'; import { Observable } from 'rxjs'; /** -* Services for calling the Controlpanel caas-ingress endpoints to get Kubernetes details. +* Services for calling the Control Panel caas-ingress endpoints to get Kubernetes details. */ @Injectable({ providedIn: 'root' diff --git a/webapp-frontend/src/app/services/controlpanel/controlpanel.service.ts b/webapp-frontend/src/app/services/controlpanel/controlpanel.service.ts index 7391a7a..5aed53b 100644 --- a/webapp-frontend/src/app/services/controlpanel/controlpanel.service.ts +++ b/webapp-frontend/src/app/services/controlpanel/controlpanel.service.ts @@ -28,7 +28,7 @@ import { ControlpanelSuccessTransport, EcompUser } from '../../interfaces/contro }) /** - * Services to query the Controlpanel's admin endpoints. + * Services to query the Control Panel's admin endpoints. */ export class ControlpanelService { @@ -47,7 +47,7 @@ export class ControlpanelService { } /** - * Gets Controlpanel version details + * Gets Control Panel version details * @returns Observable that should yield a ControlpanelSuccessTransport object */ getVersion(): Observable { @@ -55,7 +55,7 @@ export class ControlpanelService { } /** - * Gets Controlpanel users + * Gets Control Panel users * @returns Observable that should yield a EcompUser array */ getUsers(): Observable { diff --git a/webapp-frontend/src/index.html b/webapp-frontend/src/index.html index 817c092..83f24ae 100644 --- a/webapp-frontend/src/index.html +++ b/webapp-frontend/src/index.html @@ -22,7 +22,7 @@ - Non-RT RIC Controlpanel + Non-RT RIC Control Panel