From ebad840ed38c01162e300772a010204a5ca97da8 Mon Sep 17 00:00:00 2001 From: kasundharmadasa Date: Wed, 10 Apr 2019 12:26:34 +0530 Subject: [PATCH] adding style changes --- internal/scan-manager/webapp/pom.xml | 87 +++++++++++-------- .../tools/scanmanager/webapp/Application.java | 3 + .../ScanManagerWebappConfiguration.java | 40 ++++++--- ...ScanManagerWebappConfigurationBuilder.java | 2 +- .../webapp/config/ServletInitializer.java | 3 + .../webapp/config/StartUpInit.java | 2 +- .../webapp/controller/ScanController.java | 5 +- .../webapp/handlers/HttpRequestHandler.java | 4 +- .../webapp/service/ScanService.java | 4 +- .../scanmanager/webapp/util/Constants.java | 3 + .../tools/scanmanager/webapp/util/Utils.java | 3 + .../resources/scan-manager-webapp-config.yaml | 4 +- 12 files changed, 103 insertions(+), 57 deletions(-) diff --git a/internal/scan-manager/webapp/pom.xml b/internal/scan-manager/webapp/pom.xml index a995ff57..45a2aee3 100644 --- a/internal/scan-manager/webapp/pom.xml +++ b/internal/scan-manager/webapp/pom.xml @@ -24,85 +24,67 @@ 1.0-SNAPSHOT scan manager webapp http://maven.apache.org - - org.springframework.boot - spring-boot-starter-parent - 1.5.6.RELEASE - - org.springframework.boot spring-boot-starter + ${org.springframework.version} org.springframework.boot spring-boot-starter-web - - - org.springframework - spring-webmvc - 4.3.10.RELEASE + ${org.springframework.version} javax.servlet jstl - 1.2 + ${javax.servlet.jstl.version} org.apache.tomcat.embed tomcat-embed-jasper - - - org.apache.httpcomponents - httpmime - 4.5.3 - - - org.springframework.boot - spring-boot-starter-mail + ${tomcat.version} org.json json - 20131018 + ${org.json.version} org.yaml snakeyaml - 1.24 + ${org.yaml.sankeyaml.version} com.nimbusds nimbus-jose-jwt - 2.26.1 - - - org.springframework.retry - spring-retry - 1.2.1.RELEASE + ${com.nimbusds.jose.version} com.fasterxml.jackson.dataformat jackson-dataformat-yaml - 2.3.0 + ${com.fasterxml.jackson.dataformat.yaml.version} com.fasterxml.jackson.core jackson-databind - 2.7.3 + ${com.fasterxml.jackson.core.version} + + + com.fasterxml.jackson.core + jackson-core + ${com.fasterxml.jackson.core.version} org.apache.httpcomponents httpclient - 4.5.3 + ${org.apache.httpcomponents.httpclient.version} - org.apache.httpcomponents httpmime - 4.5.3 + ${org.apache.httpcomponents.httpclient.version} @@ -112,6 +94,7 @@ org.springframework.boot spring-boot-maven-plugin + ${org.springframework.version} org.wso2.security.tools.scanmanager.webapp.Application @@ -123,9 +106,32 @@ + + org.apache.maven.plugins + maven-checkstyle-plugin + ${maven.checkstyle.plugin.verson} + + + validate + validate + + + https://raw.githubusercontent.com/wso2/code-quality-tools/v1.2/checkstyle/checkstyle.xml + + UTF-8 + true + true + + + check + + + + org.apache.maven.plugins maven-compiler-plugin + ${maven.compiler.plugin.verson} 1.8 1.8 @@ -133,4 +139,17 @@ + + 20131018 + 1.24 + 2.26.1 + 1.5.6.RELEASE + 2.3.0 + 2.7.3 + 4.5.3 + 8.5.16 + 1.2 + 3.8.0 + 2.16 + diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/Application.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/Application.java index c93a1d5f..a8ede082 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/Application.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/Application.java @@ -20,6 +20,9 @@ import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; +/** + * The main class that starts the spring boot application. + */ @SpringBootApplication public class Application { diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfiguration.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfiguration.java index 406cbac1..dd9e477c 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfiguration.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfiguration.java @@ -18,8 +18,8 @@ package org.wso2.security.tools.scanmanager.webapp.config; import org.apache.http.client.utils.URIBuilder; -import org.wso2.security.tools.scanmanager.webapp.util.Constants; import org.wso2.security.tools.scanmanager.webapp.exception.ScanManagerWebappException; +import org.wso2.security.tools.scanmanager.webapp.util.Constants; import java.net.URI; import java.net.URISyntaxException; @@ -29,14 +29,19 @@ import static org.wso2.security.tools.scanmanager.webapp.util.Constants.SCANS_URI; /** - * Scan Manager webapp configuration model class + * Scan Manager webapp configuration model class. */ public class ScanManagerWebappConfiguration { private char[] clientId; private char[] clientSecret; private String scanManagerHost; - private String scanManagerPort; + private Integer scanManagerPort; + + private static final String CLIENT_ID_KEY = "clientId"; + private static final String CLIENT_SECRET_KEY = "clientSecret"; + private static final String SCAN_MANAGER_HOST_KEY = "scanManagerHost"; + private static final String SCAN_MANAGER_PORT_KEY = "scanManagerPort"; private static final ScanManagerWebappConfiguration scanManagerWebappConfiguration = new ScanManagerWebappConfiguration(); @@ -45,10 +50,10 @@ private ScanManagerWebappConfiguration() { } public void init(Map configObjectMap) { - this.clientId = (char[]) configObjectMap.get("clientId"); - this.clientSecret = (char[]) configObjectMap.get("clientSecret"); - this.scanManagerHost = (String) configObjectMap.get("scanManagerHost"); - this.scanManagerPort = (String) configObjectMap.get("scanManagerPort"); + this.clientId = (char[]) configObjectMap.get(CLIENT_ID_KEY); + this.clientSecret = (char[]) configObjectMap.get(CLIENT_SECRET_KEY); + this.scanManagerHost = (String) configObjectMap.get(SCAN_MANAGER_HOST_KEY); + this.scanManagerPort = (Integer) configObjectMap.get(SCAN_MANAGER_PORT_KEY); } public static ScanManagerWebappConfiguration getInstance() { @@ -68,30 +73,41 @@ public String getScanManagerHost() { } public int getScanManagerPort() throws NumberFormatException { - return Integer.parseInt(scanManagerPort); + return scanManagerPort; } + /** + * Building the scans URL. + * + * @return + * @throws ScanManagerWebappException + */ public URI getScanURL() throws ScanManagerWebappException { URI uri = null; try { uri = (new URIBuilder()) .setHost(scanManagerHost) - .setPort(Integer.parseInt(scanManagerPort)) + .setPort(scanManagerPort) .setScheme(Constants.SCHEME).setPath(SCANS_URI) .build(); } catch (URISyntaxException e) { - throw new ScanManagerWebappException("Unable to build the start scan URL", e); + throw new ScanManagerWebappException("Unable to build the scanS URL", e); } return uri; } - + /** + * Building the scanners URL. + * + * @return + * @throws ScanManagerWebappException + */ public URI getScannersURL() throws ScanManagerWebappException { URI uri = null; try { uri = (new URIBuilder()) .setHost(scanManagerHost) - .setPort(Integer.parseInt(scanManagerPort)) + .setPort(scanManagerPort) .setScheme(Constants.SCHEME).setPath(SCANNERS_URI) .build(); } catch (URISyntaxException e) { diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfigurationBuilder.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfigurationBuilder.java index fdbcf979..ea2cd377 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfigurationBuilder.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ScanManagerWebappConfigurationBuilder.java @@ -39,7 +39,7 @@ private ScanManagerWebappConfigurationBuilder() { } /** - * Reading the scan manager webapp configuration from scan-manager-webapp-config.yaml + * Reading the scan manager webapp configuration from scan-manager-webapp-config.yaml. * * @return * @throws ScanManagerWebappException diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ServletInitializer.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ServletInitializer.java index d0272aa4..b4536204 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ServletInitializer.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/ServletInitializer.java @@ -20,6 +20,9 @@ import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.web.support.SpringBootServletInitializer; +/** + * Spring boot servlet initializer class. + */ public class ServletInitializer extends SpringBootServletInitializer { @Override diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/StartUpInit.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/StartUpInit.java index dcca0ae5..8542656d 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/StartUpInit.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/config/StartUpInit.java @@ -25,7 +25,7 @@ import javax.annotation.PostConstruct; /** - * This class defines start up methods of the application + * This class defines start up methods of the application. */ @Component public class StartUpInit { diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/controller/ScanController.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/controller/ScanController.java index bf79a451..ea9f6f31 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/controller/ScanController.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/controller/ScanController.java @@ -41,7 +41,7 @@ import javax.servlet.ServletContext; /** - * Controller methods to resolve views + * Controller methods to resolve views. */ @Controller @RequestMapping("scanManager") @@ -87,8 +87,7 @@ public ModelAndView startScan(MultipartHttpServletRequest multipartHttpServletRe if (status == HttpStatus.SC_OK) { return successView; } else { - failureView.addObject(MESSAGE_ATTRIBUTE, "An error occurred while " + - "initiating the scan."); + failureView.addObject(MESSAGE_ATTRIBUTE, "An error occurred while initiating the scan."); return failureView; } } diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/handlers/HttpRequestHandler.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/handlers/HttpRequestHandler.java index e9821579..f529d386 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/handlers/HttpRequestHandler.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/handlers/HttpRequestHandler.java @@ -32,7 +32,7 @@ public class HttpRequestHandler { /** - * Send a POST Request + * Send a POST Request. * @param url * @param requestHeaders * @param requestParams @@ -47,7 +47,7 @@ public ResponseEntity sendPOST(String url, MultiValueMap } /** - * Send a GET request + * Send a GET request. * @param url * @param requestHeaders * @param requestParams diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/service/ScanService.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/service/ScanService.java index e9388e46..2be2525a 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/service/ScanService.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/service/ScanService.java @@ -68,7 +68,7 @@ public class ScanService { private static final String CONTENT_TYPE_HEADER_VALUE = "application/json"; /** - * Start a scan + * Start a scan. * * @param multipartFileMultiValueMap * @param parameterMap @@ -104,7 +104,7 @@ public int startScan(Map multipartFileMultiValueMap, Map< } /** - * Get the list of scanners + * Get the list of scanners. * * @return */ diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Constants.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Constants.java index 15a531c8..f76ace4d 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Constants.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Constants.java @@ -17,6 +17,9 @@ */ package org.wso2.security.tools.scanmanager.webapp.util; +/** + * Constants class for scan manager webapp. + */ public class Constants { private Constants() { diff --git a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Utils.java b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Utils.java index c36a7193..1bea0459 100644 --- a/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Utils.java +++ b/internal/scan-manager/webapp/src/main/java/org/wso2/security/tools/scanmanager/webapp/util/Utils.java @@ -22,6 +22,9 @@ import java.util.ArrayList; import java.util.List; +/** + * Utility class for scan manager webapp. + */ public class Utils { private Utils() { diff --git a/internal/scan-manager/webapp/src/main/resources/scan-manager-webapp-config.yaml b/internal/scan-manager/webapp/src/main/resources/scan-manager-webapp-config.yaml index 2b8f09ed..112b88df 100644 --- a/internal/scan-manager/webapp/src/main/resources/scan-manager-webapp-config.yaml +++ b/internal/scan-manager/webapp/src/main/resources/scan-manager-webapp-config.yaml @@ -19,5 +19,5 @@ clientId: clientSecret: -scanManagerHost: -scanManagerPort: \ No newline at end of file +scanManagerHost: localhost +scanManagerPort: 8080 \ No newline at end of file