summaryrefslogtreecommitdiffstats
path: root/controlloop/common/model-impl/so
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2018-09-21 20:08:11 -0400
committerPamela Dragosh <pdragosh@research.att.com>2018-09-24 15:30:14 -0400
commita24a985d328b97f50a41d3448d235866af625ca9 (patch)
tree06c95950000fc2b512ec1e4da5aded2c5bc84e78 /controlloop/common/model-impl/so
parent3c52de0725c942fe1f2fdeb05c8960645bc66f01 (diff)
Fix checkstyle declarations
I fixed what I thought would be tolerable for this release. Same issue as policy/common I had to defined the checkstyle in each repo where the suppressions were needed. Issue-ID: POLICY-1135 Change-Id: I8f30bee7e9cddc692ddad3cf88acedb2e6b4781b Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
Diffstat (limited to 'controlloop/common/model-impl/so')
-rw-r--r--controlloop/common/model-impl/so/checkstyle-suppressions.xml30
-rw-r--r--controlloop/common/model-impl/so/pom.xml41
-rw-r--r--controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SOManager.java65
-rw-r--r--controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java3
4 files changed, 107 insertions, 32 deletions
diff --git a/controlloop/common/model-impl/so/checkstyle-suppressions.xml b/controlloop/common/model-impl/so/checkstyle-suppressions.xml
new file mode 100644
index 000000000..01bb15f8a
--- /dev/null
+++ b/controlloop/common/model-impl/so/checkstyle-suppressions.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2018 AT&T Technologies. All rights reserved.
+ ================================================================================
+ 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.
+
+ SPDX-License-Identifier: Apache-2.0
+ ============LICENSE_END=========================================================
+-->
+
+<!DOCTYPE suppressions PUBLIC
+ "-//Puppy Crawl//DTD Suppressions 1.0//EN"
+ "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd">
+
+<suppressions>
+ <suppress checks="AbbreviationAsWordInName"
+ files="SORequest.java|SORequestDetails.java|SORequestReference.java|SORequestInfo.java|SORequestError.java|SORequestParameters.java|SOResponse.java|SOResponseWrapper.java|SOServiceExceptionHolder.java|SOSubscriberInfo.java|SOManager.java|SOCloudConfiguration.java|SOAsyncRequestStatus.java|SOInstanceReferences.java|SOModelInfo.java|SORelatedInstance.java|SORelatedInstanceList.java|SORequestStatus.java|SORequestReferences.java|SOPolicyExceptionHolder.java|SORelatedInstanceListElement.java"
+ lines="1-9999"/>
+</suppressions>
diff --git a/controlloop/common/model-impl/so/pom.xml b/controlloop/common/model-impl/so/pom.xml
index 549f3a40c..d09a2b2ec 100644
--- a/controlloop/common/model-impl/so/pom.xml
+++ b/controlloop/common/model-impl/so/pom.xml
@@ -70,4 +70,45 @@
<scope>test</scope>
</dependency>
</dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>onap-java-style</id>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ <phase>process-sources</phase>
+ <configuration>
+ <!-- Use Google Java Style Guide:
+ https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
+ with minor changes -->
+ <configLocation>onap-checkstyle/onap-java-style.xml</configLocation>
+ <!-- <sourceDirectory> is needed so that checkstyle ignores the generated sources directory -->
+ <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
+ <includeResources>true</includeResources>
+ <includeTestSourceDirectory>true</includeTestSourceDirectory>
+ <includeTestResources>true</includeTestResources>
+ <excludes>
+ </excludes>
+ <suppressionsLocation>${project.basedir}/checkstyle-suppressions.xml</suppressionsLocation>
+ <consoleOutput>true</consoleOutput>
+ <failsOnViolation>true</failsOnViolation>
+ <violationSeverity>warning</violationSeverity>
+ </configuration>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>org.onap.oparent</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>${oparent.version}</version>
+ <scope>compile</scope>
+ </dependency>
+ </dependencies>
+ </plugin>
+ </plugins>
+ </build>
</project>
diff --git a/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SOManager.java b/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SOManager.java
index 5acd973ef..20b1ac57b 100644
--- a/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SOManager.java
+++ b/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SOManager.java
@@ -77,7 +77,7 @@ public final class SOManager {
* @param username user name on SO
* @param password password on SO
* @param request the request to issue to SO
- * @return
+ * @return the SO Response object
*/
public SOResponse createModuleInstance(final String url, final String urlBase, final String username,
final String password, final SORequest request) {
@@ -89,7 +89,7 @@ public final class SOManager {
restManager.post(url, username, password, createSimpleHeaders(), MEDIA_TYPE, requestJson);
// Process the response from SO
- SOResponse response = waitForSOOperationCompletion(urlBase, username, password, url, httpResponse);
+ SOResponse response = waitForSoOperationCompletion(urlBase, username, password, url, httpResponse);
if (SO_RESPONSE_ERROR != response.getHttpResponseCode()) {
return response;
} else {
@@ -98,22 +98,21 @@ public final class SOManager {
}
/**
- * Works just like {@link SOManager#asyncSORestCall(String, WorkingMemory, String, String, String, SORequest)
- * except the vfModuleInstanceId is always null
+ * Works just like SOManager#asyncSORestCall(String, WorkingMemory, String, String, String, SORequest)
+ * except the vfModuleInstanceId is always null.
*
- * @see SOManager#asyncSORestCall(String, WorkingMemory, String, String, String, SORequest)
*/
- public Future<SOResponse> asyncSORestCall(final String requestID, final WorkingMemory wm,
+ public Future<SOResponse> asyncSORestCall(final String requestId, final WorkingMemory wm,
final String serviceInstanceId, final String vnfInstanceId,
final SORequest request) {
- return asyncSORestCall(requestID, wm, serviceInstanceId, vnfInstanceId, null, request);
+ return asyncSORestCall(requestId, wm, serviceInstanceId, vnfInstanceId, null, request);
}
/**
* This method makes an asynchronous Rest call to MSO and inserts the response into
* Drools working memory.
*
- * @param requestID
+ * @param requestId the request id
* @param wm the Drools working memory
* @param serviceInstanceId service instance id to construct the request url
* @param vnfInstanceId vnf instance id to construct the request url
@@ -122,18 +121,20 @@ public final class SOManager {
* @param request the SO request
* @return a concurrent Future for the thread that handles the request
*/
- public Future<SOResponse> asyncSORestCall(final String requestID, final WorkingMemory wm,
- final String serviceInstanceId, final String vnfInstanceId, final String vfModuleInstanceId, final
- SORequest request) {
- return executors.submit(new AsyncSORestCallThread(requestID, wm, serviceInstanceId, vnfInstanceId,
+ public Future<SOResponse> asyncSORestCall(final String requestId,
+ final WorkingMemory wm,
+ final String serviceInstanceId,
+ final String vnfInstanceId,
+ final String vfModuleInstanceId, final SORequest request) {
+ return executors.submit(new AsyncSoRestCallThread(requestId, wm, serviceInstanceId, vnfInstanceId,
vfModuleInstanceId, request));
}
/**
* This class handles an asynchronous request to SO as a thread.
*/
- private class AsyncSORestCallThread implements Callable<SOResponse> {
- final String requestID;
+ private class AsyncSoRestCallThread implements Callable<SOResponse> {
+ final String requestId;
final WorkingMemory wm;
final String serviceInstanceId;
final String vnfInstanceId;
@@ -150,9 +151,11 @@ public final class SOManager {
* @param vfModuleInstanceId the vf module instance id (not null in case of delete vf module request)
* @param request the request itself
*/
- private AsyncSORestCallThread(final String requestID, final WorkingMemory wm, final String serviceInstanceId,
- final String vnfInstanceId, final String vfModuleInstanceId, final SORequest request) {
- this.requestID = requestID;
+ private AsyncSoRestCallThread(final String requestId,
+ final WorkingMemory wm, final String serviceInstanceId,
+ final String vnfInstanceId, final String vfModuleInstanceId,
+ final SORequest request) {
+ this.requestId = requestId;
this.wm = wm;
this.serviceInstanceId = serviceInstanceId;
this.vnfInstanceId = vnfInstanceId;
@@ -191,10 +194,10 @@ public final class SOManager {
}
// Process the response from SO
- SOResponse response = waitForSOOperationCompletion(urlBase, username, password, url, httpResponse);
+ SOResponse response = waitForSoOperationCompletion(urlBase, username, password, url, httpResponse);
// Return the response to Drools in its working memory
- SOResponseWrapper soWrapper = new SOResponseWrapper(response, requestID);
+ SOResponseWrapper soWrapper = new SOResponseWrapper(response, requestId);
wm.insert(soWrapper);
return response;
@@ -211,11 +214,11 @@ public final class SOManager {
* @param initialHTTPResponse The initial HTTP message returned from SO
* @return The parsed final response of SO to the request
*/
- private SOResponse waitForSOOperationCompletion(final String urlBaseSO, final String username,
+ private SOResponse waitForSoOperationCompletion(final String urlBaseSO, final String username,
final String password, final String initialRequestURL,
final Pair<Integer, String> initialHTTPResponse) {
// Process the initial response from SO, the response to a post
- SOResponse response = processSOResponse(initialRequestURL, initialHTTPResponse);
+ SOResponse response = processSoResponse(initialRequestURL, initialHTTPResponse);
if (SO_RESPONSE_ERROR == response.getHttpResponseCode()) {
return response;
}
@@ -224,7 +227,7 @@ public final class SOManager {
String urlGet = urlBaseSO + "/orchestrationRequests/v5/" + response.getRequestReferences().getRequestId();
// The HTTP status code of the latest response
- Pair<Integer, String> latestHTTPResponse = initialHTTPResponse;
+ Pair<Integer, String> latestHttpResponse = initialHTTPResponse;
// Wait for the response from SO
for (int attemptsLeft = GET_REQUESTS_BEFORE_TIMEOUT; attemptsLeft >= 0; attemptsLeft--) {
@@ -232,7 +235,7 @@ public final class SOManager {
// response
// here before
// issuing any other requests
- if (isRequestStateFinished(latestHTTPResponse, response)) {
+ if (isRequestStateFinished(latestHttpResponse, response)) {
return response;
}
@@ -252,13 +255,13 @@ public final class SOManager {
Pair<Integer, String> httpResponse = restManager.get(urlGet, username, password, createSimpleHeaders());
// Get our response
- response = processSOResponse(urlGet, httpResponse);
+ response = processSoResponse(urlGet, httpResponse);
if (SO_RESPONSE_ERROR == response.getHttpResponseCode()) {
return response;
}
// Our latest HTTP response code
- latestHTTPResponse = httpResponse;
+ latestHttpResponse = httpResponse;
}
// We have timed out on the SO request
@@ -273,7 +276,7 @@ public final class SOManager {
* @param httpResponse The HTTP message returned from SO
* @return The parsed response
*/
- private SOResponse processSOResponse(final String requestURL, final Pair<Integer, String> httpResponse) {
+ private SOResponse processSoResponse(final String requestUrl, final Pair<Integer, String> httpResponse) {
SOResponse response = new SOResponse();
// A null httpDetails indicates a HTTP problem, a valid response from SO must be
@@ -299,10 +302,10 @@ public final class SOManager {
response.setHttpResponseCode(httpResponse.first);
}
- netLogger.info("[IN|{}|{}|]{}{}", "SO", requestURL, LINE_SEPARATOR, httpResponse.second);
+ netLogger.info("[IN|{}|{}|]{}{}", "SO", requestUrl, LINE_SEPARATOR, httpResponse.second);
if (logger.isDebugEnabled()) {
- logger.debug("***** Response to SO Request to URL {}:", requestURL);
+ logger.debug("***** Response to SO Request to URL {}:", requestUrl);
logger.debug(httpResponse.second);
}
@@ -332,12 +335,12 @@ public final class SOManager {
/**
* Check that the request state of a response is finished.
*
- * @param latestHTTPDetails the HTTP details of the response
+ * @param latestHttpDetails the HTTP details of the response
* @param response The response to check
* @return true if the request for the response is finished
*/
- private boolean isRequestStateFinished(final Pair<Integer, String> latestHTTPDetails, final SOResponse response) {
- if (latestHTTPDetails != null && 200 == latestHTTPDetails.first && isRequestStateDefined(response)) {
+ private boolean isRequestStateFinished(final Pair<Integer, String> latestHttpDetails, final SOResponse response) {
+ if (latestHttpDetails != null && 200 == latestHttpDetails.first && isRequestStateDefined(response)) {
String requestState = response.getRequest().getRequestStatus().getRequestState();
return "COMPLETE".equalsIgnoreCase(requestState) || "FAILED".equalsIgnoreCase(requestState);
} else {
diff --git a/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java b/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java
index 7619e3a84..191ee05d2 100644
--- a/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java
+++ b/controlloop/common/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java
@@ -3,6 +3,7 @@
* so
* ================================================================================
* Copyright (C) 2018 Amdocs. All rights reserved.
+ * Modifications Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,7 +22,7 @@
package org.onap.policy.so;
/**
- * Enumeration of SO Operations type that can be performed by a policy
+ * Enumeration of SO Operations type that can be performed by a policy.
*/
public enum SoOperationType {
SCALE_OUT("Create Vf Module"),