Fix policy/common checkstyle issues

The root pom.xml had a syntax error in a declaration. The suppressions
xml was not being found by the sub-modules. It was better to create a
copy in each of the sub-modules where we will not be fixing
abbreviations or the interface declarations in own java file.

Added specific checkstyle files for each submodule.

One interesting note for the InheritDoc tag. It seems that the mvn
compile has a bug that interprets these as missing a period after
the tag. Even though the parent interface has it correctly. It was
easier to just remove it than duplicate.

There are new JIRA's for that work to be done in Dublin.

Fixed some spacing in pom's.

Issue-ID: POLICY-1131
Change-Id: I5f845958ccefd50a3b7290662da43c994870f1f7
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

2 files changed, 151 insertions, 82 deletions

diff --git a/common-logging/checkstyle-suppressions.xml b/common-logging/checkstyle-suppressions.xml
new file mode 100644
index 00000000..0d169509
--- /dev/null
+++ b/common-logging/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="ONAPLoggingUtils.java|ONAPLoggingContext.java|DroolsPDPMDCInfo.java|Logger.java|EventData.java|EventTrackInfo.java|MDCInfo.java|PolicyLogger.java|SystemOutLoggerTest.java|Logger4JTest.java|EelfLoggerTest.java|PolicyLoggerTest.java|DroolsPDPMDCInfoTest.java|EventTrackInfoTest.java|HttpClientTest.java"
+    lines="1-9999"/>
+</suppressions>
diff --git a/common-logging/pom.xml b/common-logging/pom.xml
index 143ae6b8..2d3186b9 100644
--- a/common-logging/pom.xml
+++ b/common-logging/pom.xml
@@ -18,92 +18,131 @@
   ============LICENSE_END=========================================================
   -->
 
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-  <modelVersion>4.0.0</modelVersion>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
 
-  	<parent>
-		<groupId>org.onap.policy.common</groupId>
-		<artifactId>common-modules</artifactId>
-		<version>1.3.0-SNAPSHOT</version>
-	</parent>
+    <parent>
+        <groupId>org.onap.policy.common</groupId>
+        <artifactId>common-modules</artifactId>
+        <version>1.3.0-SNAPSHOT</version>
+    </parent>
 
-  <artifactId>ONAP-Logging</artifactId>
-  <description>ONAP Logging Framework</description>
-  <packaging>jar</packaging>
-  
-  <properties>
-	<powermock.version>1.6.6</powermock.version>
-  </properties>
+    <artifactId>ONAP-Logging</artifactId>
+    <description>ONAP Logging Framework</description>
+    <packaging>jar</packaging>
+
+    <properties>
+        <powermock.version>1.6.6</powermock.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>log4j</groupId>
+            <artifactId>log4j</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>javax.servlet-api</artifactId>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.att.eelf</groupId>
+            <artifactId>eelf-core</artifactId>
+            <version>1.0.1-oss</version>
+        </dependency>
+        <dependency>
+            <groupId>org.powermock</groupId>
+            <artifactId>powermock-api-mockito</artifactId>
+            <version>${powermock.version}</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
 
-  <dependencies>
-	<dependency>
-		<groupId>log4j</groupId>
-		<artifactId>log4j</artifactId>
-		<scope>provided</scope>
-	</dependency>
-    <dependency>
-      <groupId>javax.servlet</groupId>
-      <artifactId>javax.servlet-api</artifactId>
-      <scope>compile</scope>
-    </dependency>
-	<dependency>
-		<groupId>org.slf4j</groupId>
-		<artifactId>slf4j-api</artifactId>
-	</dependency>
-	<dependency>
-	    <groupId>com.att.eelf</groupId>
-		<artifactId>eelf-core</artifactId>
-		<version>1.0.1-oss</version>
-	</dependency>
-	<dependency>
-		<groupId>org.powermock</groupId>
-		<artifactId>powermock-api-mockito</artifactId>
-		<version>${powermock.version}</version>
-		<scope>test</scope>
-	</dependency>
-  </dependencies>
- 
-	<build>
-		<plugins>
-			<plugin>
-				<groupId>com.att.eelf</groupId>
-				<artifactId>eelf-maven-plugin</artifactId>
-				<version>0.0.1</version>
-				<executions>
-					<execution>
-						<phase>install</phase>
-						<goals>
-							<goal>WikiMsgGenerator</goal>
-						</goals>
-					</execution>
-				</executions>
-				<dependencies>
-					<!-- We need to include the dependency of the project so that its include 
-						in classpath when running plugin -->
-					<dependency>
-						<groupId>org.onap.policy.common</groupId>
-						<artifactId>ONAP-Logging</artifactId>
-						<version>${project.version}</version>
-					</dependency>
-				</dependencies>
-				<configuration>
-					<outputDirectory>target/messages</outputDirectory>
-					<outputFile>messages.html</outputFile>
-					<resources>
-						<resource>
-							<messageClass>org.onap.policy.common.logging.eelf.MessageCodes</messageClass>
-							This needs to be replaced with your Enum class name .which
-							implements EELFResolvableErrorEnum and have your defined error
-							codes.
-							<header><![CDATA[<p>   <ac:macro ac:name="toc" /> </p>
+    <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>
+            <plugin>
+                <groupId>com.att.eelf</groupId>
+                <artifactId>eelf-maven-plugin</artifactId>
+                <version>0.0.1</version>
+                <executions>
+                    <execution>
+                        <phase>install</phase>
+                        <goals>
+                            <goal>WikiMsgGenerator</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <dependencies>
+                    <!-- We need to include the dependency of the project so that its include 
+                        in classpath when running plugin -->
+                    <dependency>
+                        <groupId>org.onap.policy.common</groupId>
+                        <artifactId>ONAP-Logging</artifactId>
+                        <version>${project.version}</version>
+                    </dependency>
+                </dependencies>
+                <configuration>
+                    <outputDirectory>target/messages</outputDirectory>
+                    <outputFile>messages.html</outputFile>
+                    <resources>
+                        <resource>
+                            <messageClass>org.onap.policy.common.logging.eelf.MessageCodes</messageClass>
+                            This needs to be replaced with your Enum
+                            class name .which
+                            implements EELFResolvableErrorEnum and have your defined error
+                            codes.
+                            <header><![CDATA[<p>   <ac:macro ac:name="toc" /> </p>
                 <p>
         <ac:macro ac:name="anchor"> <ac:default-parameter>Application Messages</ac:default-parameter>  </ac:macro> </p> <h2>Application Messages</h2>]]></header>
-						</resource>
+                        </resource>
 
-					</resources>
-				</configuration>
-			</plugin>
-		</plugins>
-	</build>
+                    </resources>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
 </project>