SwaggerConfig,ResourceAssignmentInitializer-Sonar
authorArundathi Patil <arundpil@in.ibm.com>
Tue, 30 Oct 2018 08:42:12 +0000 (14:12 +0530)
committerDan Timoney <dtimoney@att.com>
Fri, 2 Nov 2018 18:07:49 +0000 (18:07 +0000)
Fixed sonar issues/code-smells accross these files

Issue-ID: CCSDK-631
Change-Id: I0312937af688341e37b68f7da6229fdf935d620d
Signed-off-by: Arundathi Patil <arundpil@in.ibm.com>
ms/controllerblueprints/application/src/main/java/org/onap/ccsdk/apps/controllerblueprints/SwaggerConfig.java

index cfcccf3..8b96f04 100644 (file)
-/*\r
- *  Copyright © 2017-2018 AT&T Intellectual Property.\r
- *\r
- *  Licensed under the Apache License, Version 2.0 (the "License");\r
- *  you may not use this file except in compliance with the License.\r
- *  You may obtain a copy of the License at\r
- *\r
- *      http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- *  Unless required by applicable law or agreed to in writing, software\r
- *  distributed under the License is distributed on an "AS IS" BASIS,\r
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- *  See the License for the specific language governing permissions and\r
- *  limitations under the License.\r
- */\r
-\r
-package org.onap.ccsdk.apps.controllerblueprints;\r
-\r
-import com.google.common.collect.Lists;\r
-import org.jetbrains.annotations.NotNull;\r
-import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintConstants;\r
-import org.springframework.beans.factory.annotation.Value;\r
-import org.springframework.context.annotation.Bean;\r
-import org.springframework.context.annotation.Configuration;\r
-import org.springframework.http.HttpStatus;\r
-import org.springframework.web.bind.annotation.RequestMethod;\r
-import springfox.documentation.builders.PathSelectors;\r
-import springfox.documentation.builders.RequestHandlerSelectors;\r
-import springfox.documentation.builders.ResponseMessageBuilder;\r
-import springfox.documentation.schema.ModelRef;\r
-import springfox.documentation.service.ApiInfo;\r
-import springfox.documentation.service.Contact;\r
-import springfox.documentation.service.Header;\r
-import springfox.documentation.service.ResponseMessage;\r
-import springfox.documentation.spi.DocumentationType;\r
-import springfox.documentation.spring.web.plugins.Docket;\r
-import springfox.documentation.swagger2.annotations.EnableSwagger2;\r
-\r
-import java.util.Collections;\r
-import java.util.HashMap;\r
-import java.util.List;\r
-import java.util.Map;\r
-\r
-/**\r
- * SwaggerConfig\r
- *\r
- * @author Brinda Santh 8/13/2018\r
- */\r
-@Configuration\r
-@EnableSwagger2\r
-@SuppressWarnings("unused")\r
-public class SwaggerConfig {\r
-    @Value("${appVersion}")\r
-    private String appVersion;\r
-    @Value("${swagger.contact.name}")\r
-    private String contactName;\r
-    @Value("${swagger.contact.url}")\r
-    private String contactUrl;\r
-    @Value("${swagger.contact.email}")\r
-    private String contactEmail;\r
-\r
-    @Bean\r
-    @SuppressWarnings("unused")\r
-    public Docket api() {\r
-        return new Docket(DocumentationType.SWAGGER_2)\r
-                .globalResponseMessage(RequestMethod.GET, getDefaultGetResponseMessages())\r
-                .globalResponseMessage(RequestMethod.POST, getDefaultPostResponseMessages())\r
-                .globalResponseMessage(RequestMethod.PUT, getDefaultPutResponseMessages())\r
-                .globalResponseMessage(RequestMethod.DELETE, getDefaultDeleteResponseMessages())\r
-                .select()\r
-                .apis(RequestHandlerSelectors.any())\r
-                .paths(PathSelectors.any())\r
-                .build()\r
-                .apiInfo(apiInfo());\r
-    }\r
-\r
-    private ApiInfo apiInfo() {\r
-        return new ApiInfo(\r
-                "Controller Blueprints API",\r
-                "Controller blueprints API for VNF Self Service.",\r
-                appVersion,\r
-                "Terms of service",\r
-                new Contact(contactName, contactUrl, contactEmail),\r
-                "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", Collections.emptyList());\r
-    }\r
-\r
-    private List<ResponseMessage> getDefaultGetResponseMessages() {\r
-        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();\r
-        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.NOT_FOUND, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));\r
-        return defaultResponseMessages;\r
-    }\r
-\r
-    private List<ResponseMessage> getDefaultPostResponseMessages() {\r
-        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();\r
-        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.CREATED, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));\r
-        return defaultResponseMessages;\r
-    }\r
-\r
-    private List<ResponseMessage> getDefaultPutResponseMessages() {\r
-        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();\r
-        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));\r
-        return defaultResponseMessages;\r
-    }\r
-\r
-    private List<ResponseMessage> getDefaultDeleteResponseMessages() {\r
-        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();\r
-        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));\r
-        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));\r
-        return defaultResponseMessages;\r
-    }\r
-\r
-    private ResponseMessage getResponseBuilder(@NotNull HttpStatus httpStatus, Map<String, Header> defaultHeaders) {\r
-        ResponseMessageBuilder responseMessageBuilder = new ResponseMessageBuilder();\r
-        responseMessageBuilder.code(httpStatus.value())\r
-                .message(httpStatus.getReasonPhrase())\r
-                .headersWithDescription(defaultHeaders)\r
-                .build();\r
-        return responseMessageBuilder.build();\r
-    }\r
-\r
-    private Map<String, Header> getDefaultResponseHeaders() {\r
-        Map<String, Header> defaultHeaders = new HashMap<>();\r
-        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_TRANSACTION_ID,\r
-                new Header(BluePrintConstants.RESPONSE_HEADER_TRANSACTION_ID, "Transaction Id", new ModelRef("string")));\r
-        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_LATEST_VERSION,\r
-                new Header(BluePrintConstants.RESPONSE_HEADER_LATEST_VERSION, "API Latest Version", new ModelRef("string")));\r
-        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_MINOR_VERSION,\r
-                new Header(BluePrintConstants.RESPONSE_HEADER_MINOR_VERSION, "API Minor Version", new ModelRef("string")));\r
-        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_PATCH_VERSION,\r
-                new Header(BluePrintConstants.RESPONSE_HEADER_PATCH_VERSION, "API Patch Version", new ModelRef("string")));\r
-        return defaultHeaders;\r
-    }\r
-}\r
+/*
+ *  Copyright © 2017-2018 AT&T Intellectual Property.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package org.onap.ccsdk.apps.controllerblueprints;
+
+import com.google.common.collect.Lists;
+import org.jetbrains.annotations.NotNull;
+import org.onap.ccsdk.apps.controllerblueprints.core.BluePrintConstants;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.RequestMethod;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.builders.ResponseMessageBuilder;
+import springfox.documentation.schema.ModelRef;
+import springfox.documentation.service.ApiInfo;
+import springfox.documentation.service.Contact;
+import springfox.documentation.service.Header;
+import springfox.documentation.service.ResponseMessage;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * SwaggerConfig
+ *
+ * @author Brinda Santh 8/13/2018
+ */
+@Configuration
+@EnableSwagger2
+@SuppressWarnings("unused")
+public class SwaggerConfig {
+    @Value("${appVersion}")
+    private String appVersion;
+    @Value("${swagger.contact.name}")
+    private String contactName;
+    @Value("${swagger.contact.url}")
+    private String contactUrl;
+    @Value("${swagger.contact.email}")
+    private String contactEmail;
+    private String stringModelRef = "string";
+
+    @Bean
+    @SuppressWarnings("unused")
+    public Docket api() {
+        return new Docket(DocumentationType.SWAGGER_2)
+                .globalResponseMessage(RequestMethod.GET, getDefaultGetResponseMessages())
+                .globalResponseMessage(RequestMethod.POST, getDefaultPostResponseMessages())
+                .globalResponseMessage(RequestMethod.PUT, getDefaultPutResponseMessages())
+                .globalResponseMessage(RequestMethod.DELETE, getDefaultDeleteResponseMessages())
+                .select()
+                .apis(RequestHandlerSelectors.any())
+                .paths(PathSelectors.any())
+                .build()
+                .apiInfo(apiInfo());
+    }
+
+    private ApiInfo apiInfo() {
+        return new ApiInfo(
+                "Controller Blueprints API",
+                "Controller blueprints API for VNF Self Service.",
+                appVersion,
+                "Terms of service",
+                new Contact(contactName, contactUrl, contactEmail),
+                "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", Collections.emptyList());
+    }
+
+    private List<ResponseMessage> getDefaultGetResponseMessages() {
+        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();
+        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.NOT_FOUND, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));
+        return defaultResponseMessages;
+    }
+
+    private List<ResponseMessage> getDefaultPostResponseMessages() {
+        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();
+        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.CREATED, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));
+        return defaultResponseMessages;
+    }
+
+    private List<ResponseMessage> getDefaultPutResponseMessages() {
+        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();
+        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));
+        return defaultResponseMessages;
+    }
+
+    private List<ResponseMessage> getDefaultDeleteResponseMessages() {
+        List<ResponseMessage> defaultResponseMessages = Lists.newArrayList();
+        Map<String, Header> defaultHeaders = getDefaultResponseHeaders();
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.OK, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.BAD_REQUEST, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.UNAUTHORIZED, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.FORBIDDEN, defaultHeaders));
+        defaultResponseMessages.add(getResponseBuilder(HttpStatus.INTERNAL_SERVER_ERROR, defaultHeaders));
+        return defaultResponseMessages;
+    }
+
+    private ResponseMessage getResponseBuilder(@NotNull HttpStatus httpStatus, Map<String, Header> defaultHeaders) {
+        ResponseMessageBuilder responseMessageBuilder = new ResponseMessageBuilder();
+        responseMessageBuilder.code(httpStatus.value())
+                .message(httpStatus.getReasonPhrase())
+                .headersWithDescription(defaultHeaders)
+                .build();
+        return responseMessageBuilder.build();
+    }
+
+    private Map<String, Header> getDefaultResponseHeaders() {
+        Map<String, Header> defaultHeaders = new HashMap<>();
+        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_TRANSACTION_ID,
+                new Header(BluePrintConstants.RESPONSE_HEADER_TRANSACTION_ID, "Transaction Id", new ModelRef(stringModelRef)));
+        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_LATEST_VERSION,
+                new Header(BluePrintConstants.RESPONSE_HEADER_LATEST_VERSION, "API Latest Version", new ModelRef(stringModelRef)));
+        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_MINOR_VERSION,
+                new Header(BluePrintConstants.RESPONSE_HEADER_MINOR_VERSION, "API Minor Version", new ModelRef(stringModelRef)));
+        defaultHeaders.put(BluePrintConstants.RESPONSE_HEADER_PATCH_VERSION,
+                new Header(BluePrintConstants.RESPONSE_HEADER_PATCH_VERSION, "API Patch Version", new ModelRef(stringModelRef)));
+        return defaultHeaders;
+    }
+}