From af5e28cc353456a28204ce8ebe792a218607d8c9 Mon Sep 17 00:00:00 2001 From: Pamela Dragosh Date: Fri, 21 Sep 2018 12:48:29 -0400 Subject: 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 --- checkstyle-suppressions.xml | 11 -- common-logging/checkstyle-suppressions.xml | 30 +++ common-logging/pom.xml | 203 +++++++++++-------- .../common/parameters/GroupValidationResult.java | 3 +- integrity-audit/checkstyle-suppressions.xml | 30 +++ integrity-audit/pom.xml | 220 ++++++++++++--------- policy-endpoints/checkstyle-suppressions.xml | 30 +++ policy-endpoints/pom.xml | 42 ++++ .../policy/common/endpoints/event/comm/Topic.java | 4 +- .../event/comm/bus/DmaapTopicSourceFactory.java | 23 --- .../event/comm/bus/UebTopicSourceFactory.java | 35 +--- .../event/comm/bus/internal/BusPublisher.java | 12 -- .../event/comm/bus/internal/BusTopicParams.java | 8 +- .../comm/bus/internal/InlineBusTopicSink.java | 20 -- .../comm/bus/internal/InlineDmaapTopicSink.java | 3 - .../comm/bus/internal/InlineUebTopicSink.java | 3 - .../bus/internal/SingleThreadedBusTopicSource.java | 18 -- .../internal/SingleThreadedDmaapTopicSource.java | 3 - .../bus/internal/SingleThreadedUebTopicSource.java | 5 - .../http/client/internal/JerseyClient.java | 4 +- .../http/server/HttpServletServerFactory.java | 35 ++-- .../endpoints/http/server/aaf/AafAuthFilter.java | 1 + .../http/server/internal/JettyServletServer.java | 2 +- .../common/endpoints/report/HealthCheckReport.java | 4 +- .../endpoints/http/server/test/HttpClientTest.java | 8 +- pom.xml | 5 +- .../onap/policy/common/utils/io/Serializer.java | 7 + .../common/utils/validation/ToStringTester.java | 11 +- 28 files changed, 446 insertions(+), 334 deletions(-) delete mode 100644 checkstyle-suppressions.xml create mode 100644 common-logging/checkstyle-suppressions.xml create mode 100644 integrity-audit/checkstyle-suppressions.xml create mode 100644 policy-endpoints/checkstyle-suppressions.xml diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml deleted file mode 100644 index 2e03c646..00000000 --- a/checkstyle-suppressions.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - 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 @@ + + + + + + + + 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========================================================= --> - - 4.0.0 + + 4.0.0 - - org.onap.policy.common - common-modules - 1.3.0-SNAPSHOT - + + org.onap.policy.common + common-modules + 1.3.0-SNAPSHOT + - ONAP-Logging - ONAP Logging Framework - jar - - - 1.6.6 - + ONAP-Logging + ONAP Logging Framework + jar + + + 1.6.6 + + + + + log4j + log4j + provided + + + javax.servlet + javax.servlet-api + compile + + + org.slf4j + slf4j-api + + + com.att.eelf + eelf-core + 1.0.1-oss + + + org.powermock + powermock-api-mockito + ${powermock.version} + test + + - - - log4j - log4j - provided - - - javax.servlet - javax.servlet-api - compile - - - org.slf4j - slf4j-api - - - com.att.eelf - eelf-core - 1.0.1-oss - - - org.powermock - powermock-api-mockito - ${powermock.version} - test - - - - - - - com.att.eelf - eelf-maven-plugin - 0.0.1 - - - install - - WikiMsgGenerator - - - - - - - org.onap.policy.common - ONAP-Logging - ${project.version} - - - - target/messages - messages.html - - - org.onap.policy.common.logging.eelf.MessageCodes - This needs to be replaced with your Enum class name .which - implements EELFResolvableErrorEnum and have your defined error - codes. -

+ + + + maven-checkstyle-plugin + + + onap-java-style + + check + + process-sources + + + onap-checkstyle/onap-java-style.xml + + ${project.build.sourceDirectory} + true + true + true + + + ${project.basedir}/checkstyle-suppressions.xml + true + true + warning + + + + + + org.onap.oparent + checkstyle + ${oparent.version} + compile + + + + + com.att.eelf + eelf-maven-plugin + 0.0.1 + + + install + + WikiMsgGenerator + + + + + + + org.onap.policy.common + ONAP-Logging + ${project.version} + + + + target/messages + messages.html + + + org.onap.policy.common.logging.eelf.MessageCodes + This needs to be replaced with your Enum + class name .which + implements EELFResolvableErrorEnum and have your defined error + codes. +

Application Messages

Application Messages

]]>
- + - - - - - + + + + + diff --git a/common-parameters/src/main/java/org/onap/policy/common/parameters/GroupValidationResult.java b/common-parameters/src/main/java/org/onap/policy/common/parameters/GroupValidationResult.java index 94d9ad49..5beef5b1 100644 --- a/common-parameters/src/main/java/org/onap/policy/common/parameters/GroupValidationResult.java +++ b/common-parameters/src/main/java/org/onap/policy/common/parameters/GroupValidationResult.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2018 Ericsson. 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. @@ -110,7 +111,7 @@ public class GroupValidationResult implements ValidationResult { } /** - * Get the value of a field in an object using a getter found with reflection + * Get the value of a field in an object using a getter found with reflection. * * @param targetObject The object on which to read the field value * @param fieldName The name of the field diff --git a/integrity-audit/checkstyle-suppressions.xml b/integrity-audit/checkstyle-suppressions.xml new file mode 100644 index 00000000..c97e4c22 --- /dev/null +++ b/integrity-audit/checkstyle-suppressions.xml @@ -0,0 +1,30 @@ + + + + + + + + diff --git a/integrity-audit/pom.xml b/integrity-audit/pom.xml index a45dac2c..a0aca29b 100644 --- a/integrity-audit/pom.xml +++ b/integrity-audit/pom.xml @@ -18,101 +18,141 @@ ============LICENSE_END========================================================= --> - + - 4.0.0 + 4.0.0 - integrity-audit + integrity-audit - jar + jar - - org.onap.policy.common - common-modules - 1.3.0-SNAPSHOT - + + org.onap.policy.common + common-modules + 1.3.0-SNAPSHOT + - Integrity Audit + Integrity Audit - - - junit - junit - test - - - log4j - log4j - - - com.h2database - h2 - - - org.eclipse.persistence - javax.persistence - - - org.eclipse.persistence - eclipselink - - - org.onap.policy.common - utils - ${project.version} - - - org.onap.policy.common - utils-test - ${project.version} - test - - - org.onap.policy.common - ONAP-Logging - ${project.version} - - - org.apache.commons - commons-lang3 - - + + + junit + junit + test + + + log4j + log4j + + + com.h2database + h2 + + + org.eclipse.persistence + javax.persistence + + + org.eclipse.persistence + eclipselink + + + org.onap.policy.common + utils + ${project.version} + + + org.onap.policy.common + utils-test + ${project.version} + test + + + org.onap.policy.common + ONAP-Logging + ${project.version} + + + org.apache.commons + commons-lang3 + + - - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - org.jacoco - - jacoco-maven-plugin - - - [0.7.1.201405082137,) - - - prepare-agent - - - - - - - - - - - - - + + + + maven-checkstyle-plugin + + + onap-java-style + + check + + process-sources + + + onap-checkstyle/onap-java-style.xml + + ${project.build.sourceDirectory} + true + true + true + + + ${project.basedir}/checkstyle-suppressions.xml + true + true + warning + + + + + + org.onap.oparent + checkstyle + ${oparent.version} + compile + + + + + + + + + org.eclipse.m2e + lifecycle-mapping + 1.0.0 + + + + + + org.jacoco + + jacoco-maven-plugin + + + [0.7.1.201405082137,) + + + prepare-agent + + + + + + + + + + + + + diff --git a/policy-endpoints/checkstyle-suppressions.xml b/policy-endpoints/checkstyle-suppressions.xml new file mode 100644 index 00000000..0b65969a --- /dev/null +++ b/policy-endpoints/checkstyle-suppressions.xml @@ -0,0 +1,30 @@ + + + + + + + + diff --git a/policy-endpoints/pom.xml b/policy-endpoints/pom.xml index 69294844..a4ac93d4 100644 --- a/policy-endpoints/pom.xml +++ b/policy-endpoints/pom.xml @@ -1,6 +1,7 @@ + onap-checkstyle/onap-java-style.xml + + ${project.build.sourceDirectory} + true + true + true + + + ${project.basedir}/checkstyle-suppressions.xml + true + true + warning + + + + + + org.onap.oparent + checkstyle + ${oparent.version} + compile + + + + + diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java index ff49a113..fece6463 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/Topic.java @@ -2,7 +2,7 @@ * ============LICENSE_START======================================================= * policy-endpoints * ================================================================================ - * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved. + * Copyright (C) 2017-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. @@ -68,7 +68,7 @@ public interface Topic extends TopicRegisterable, Startable, Lockable { /** * Gets the communication infrastructure type. * - * @return + * @return CommInfrastructure object */ public CommInfrastructure getTopicCommInfrastructure(); diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java index 30cc923b..d5e04d50 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/DmaapTopicSourceFactory.java @@ -140,10 +140,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory { */ protected HashMap dmaapTopicSources = new HashMap<>(); - - /** - * {@inheritDoc} - */ @Override public DmaapTopicSource build(BusTopicParams busTopicParams) { @@ -166,9 +162,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory { } } - /** - * {@inheritDoc} - */ @Override public List build(Properties properties) { @@ -383,11 +376,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory { return dmaapTopicSourceLst; } - /** - * {@inheritDoc} - * - * @throws IllegalArgumentException throws illegal argument exception - */ @Override public DmaapTopicSource build(List servers, String topic, String apiKey, String apiSecret) { return this.build(BusTopicParams.builder() @@ -403,19 +391,11 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory { .build()); } - /** - * {@inheritDoc} - * - * @throws IllegalArgumentException throws illegal argument exception - */ @Override public DmaapTopicSource build(List servers, String topic) { return this.build(servers, topic, null, null); } - /** - * {@inheritDoc} - */ @Override public void destroy(String topic) { @@ -448,9 +428,6 @@ class IndexedDmaapTopicSourceFactory implements DmaapTopicSourceFactory { } } - /** - * {@inheritDoc} - */ @Override public DmaapTopicSource get(String topic) { diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java index 4f62ffa4..f3f3e156 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/UebTopicSourceFactory.java @@ -130,9 +130,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory { */ protected HashMap uebTopicSources = new HashMap<>(); - /** - * {@inheritDoc} - */ @Override public UebTopicSource build(BusTopicParams busTopicParams) { if (busTopicParams.getServers() == null || busTopicParams.getServers().isEmpty()) { @@ -158,9 +155,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory { } } - /** - * {@inheritDoc} - */ @Override public List build(Properties properties) { @@ -187,18 +181,19 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory { continue; } - List serverList = new ArrayList<>(Arrays.asList(servers.split("\\s*,\\s*"))); + final List serverList = new ArrayList<>(Arrays.asList(servers.split("\\s*,\\s*"))); - String apiKey = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic - + PolicyEndPointProperties.PROPERTY_TOPIC_API_KEY_SUFFIX); + final String apiKey = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_API_KEY_SUFFIX); - String apiSecret = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." - + topic + PolicyEndPointProperties.PROPERTY_TOPIC_API_SECRET_SUFFIX); + final String apiSecret = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_API_SECRET_SUFFIX); - String consumerGroup = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." - + topic + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX); + final String consumerGroup = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_GROUP_SUFFIX); - String consumerInstance = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + final String consumerInstance = properties.getProperty( + PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS + "." + topic + PolicyEndPointProperties.PROPERTY_TOPIC_SOURCE_CONSUMER_INSTANCE_SUFFIX); String fetchTimeoutString = properties.getProperty(PolicyEndPointProperties.PROPERTY_UEB_SOURCE_TOPICS @@ -269,9 +264,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory { return newUebTopicSources; } - /** - * {@inheritDoc} - */ @Override public UebTopicSource build(List servers, String topic, String apiKey, String apiSecret) { @@ -287,17 +279,11 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory { .allowSelfSignedCerts(true).build()); } - /** - * {@inheritDoc} - */ @Override public UebTopicSource build(List servers, String topic) { return this.build(servers, topic, null, null); } - /** - * {@inheritDoc} - */ @Override public void destroy(String topic) { @@ -330,9 +316,6 @@ class IndexedUebTopicSourceFactory implements UebTopicSourceFactory { } } - /** - * {@inheritDoc} - */ @Override public UebTopicSource get(String topic) { diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java index aaf0cfb5..716ce95b 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusPublisher.java @@ -112,9 +112,6 @@ public interface BusPublisher { } } - /** - * {@inheritDoc} - */ @Override public boolean send(String partitionId, String message) { if (message == null) { @@ -130,9 +127,6 @@ public interface BusPublisher { return true; } - /** - * {@inheritDoc} - */ @Override public void close() { logger.info("{}: CLOSE", this); @@ -240,9 +234,6 @@ public interface BusPublisher { logger.info("{}: CREATION: using protocol {}", this, protocol.getValue()); } - /** - * {@inheritDoc} - */ @Override public void close() { logger.info("{}: CLOSE", this); @@ -254,9 +245,6 @@ public interface BusPublisher { } } - /** - * {@inheritDoc} - */ @Override public boolean send(String partitionId, String message) { if (message == null) { diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java index 7f03286f..b752d91c 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/BusTopicParams.java @@ -3,6 +3,7 @@ * policy-endpoints * ================================================================================ * Copyright (C) 2018 Samsung Electronics Co., Ltd. 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. @@ -20,10 +21,9 @@ package org.onap.policy.common.endpoints.event.comm.bus.internal; -import org.apache.commons.lang3.StringUtils; - import java.util.List; import java.util.Map; +import org.apache.commons.lang3.StringUtils; /** * Member variables of this Params class are as follows. @@ -174,7 +174,7 @@ public class BusTopicParams { } /** - * Methods to Check if the property is INVALID + * Methods to Check if the property is INVALID. */ boolean isEnvironmentInvalid() { @@ -231,7 +231,7 @@ public class BusTopicParams { } /** - * Methods to Check if the property is Valid + * Methods to Check if the property is Valid. */ boolean isApiKeyValid() { diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java index 6e8c4011..c8d6bd5a 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineBusTopicSink.java @@ -78,9 +78,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi */ public abstract void init(); - /** - * {@inheritDoc} - */ @Override public boolean start() { logger.info("{}: starting", this); @@ -102,9 +99,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi return true; } - /** - * {@inheritDoc} - */ @Override public boolean stop() { @@ -129,9 +123,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi return true; } - /** - * {@inheritDoc} - */ @Override public boolean send(String message) { @@ -161,26 +152,16 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi return true; } - - /** - * {@inheritDoc} - */ @Override public void setPartitionKey(String partitionKey) { this.partitionId = partitionKey; } - /** - * {@inheritDoc} - */ @Override public String getPartitionKey() { return this.partitionId; } - /** - * {@inheritDoc} - */ @Override public void shutdown() { this.stop(); @@ -208,7 +189,6 @@ public abstract class InlineBusTopicSink extends BusTopicBase implements BusTopi return true; } - @Override public String toString() { return "InlineBusTopicSink [partitionId=" + partitionId + ", alive=" + alive + ", publisher=" + publisher + "]"; diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java index eb431229..01531055 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineDmaapTopicSink.java @@ -114,9 +114,6 @@ public class InlineDmaapTopicSink extends InlineBusTopicSink implements DmaapTop logger.info("{}: DMAAP SINK created", this); } - /** - * {@inheritDoc} - */ @Override public CommInfrastructure getTopicCommInfrastructure() { return Topic.CommInfrastructure.DMAAP; diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java index b07a1966..f989f808 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/InlineUebTopicSink.java @@ -80,9 +80,6 @@ public class InlineUebTopicSink extends InlineBusTopicSink implements UebTopicSi return builder.toString(); } - /** - * {@inheritDoc} - */ @Override public CommInfrastructure getTopicCommInfrastructure() { return Topic.CommInfrastructure.UEB; diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java index 0482e860..b9463e81 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedBusTopicSource.java @@ -234,9 +234,6 @@ public abstract class SingleThreadedBusTopicSource extends BusTopicBase logger.info("{}: exiting thread", this); } - /** - * {@inheritDoc} - */ @Override public boolean offer(String event) { if (!this.alive) { @@ -272,42 +269,27 @@ public abstract class SingleThreadedBusTopicSource extends BusTopicBase + topicListeners.size() + ", toString()=" + super.toString() + "]"; } - /** - * {@inheritDoc} - */ @Override public String getConsumerGroup() { return consumerGroup; } - /** - * {@inheritDoc} - */ @Override public String getConsumerInstance() { return consumerInstance; } - /** - * {@inheritDoc} - */ @Override public void shutdown() { this.stop(); this.topicListeners.clear(); } - /** - * {@inheritDoc} - */ @Override public int getFetchTimeout() { return fetchTimeout; } - /** - * {@inheritDoc} - */ @Override public int getFetchLimit() { return fetchLimit; diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java index 45c0b6fc..8050de2a 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedDmaapTopicSource.java @@ -139,9 +139,6 @@ public class SingleThreadedDmaapTopicSource extends SingleThreadedBusTopicSource logger.info("{}: INITTED", this); } - /** - * {@inheritDoc} - */ @Override public CommInfrastructure getTopicCommInfrastructure() { return Topic.CommInfrastructure.DMAAP; diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java index 23d3edca..de6aa860 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/event/comm/bus/internal/SingleThreadedUebTopicSource.java @@ -36,8 +36,6 @@ public class SingleThreadedUebTopicSource extends SingleThreadedBusTopicSource i * @param busTopicParams Parameters object containing all the required inputs * @throws IllegalArgumentException An invalid parameter passed in */ - - public SingleThreadedUebTopicSource(BusTopicParams busTopicParams) { super(busTopicParams); @@ -65,9 +63,6 @@ public class SingleThreadedUebTopicSource extends SingleThreadedBusTopicSource i .allowSelfSignedCerts(this.allowSelfSignedCerts).build()); } - /** - * {@inheritDoc} - */ @Override public CommInfrastructure getTopicCommInfrastructure() { return Topic.CommInfrastructure.UEB; diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/client/internal/JerseyClient.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/client/internal/JerseyClient.java index 0be81099..94635615 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/client/internal/JerseyClient.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/client/internal/JerseyClient.java @@ -70,7 +70,7 @@ public class JerseyClient implements HttpClient { /** * Constructor. * - * name the name https is it https or not selfSignedCerts are there self signed certs hostname + *

name the name https is it https or not selfSignedCerts are there self signed certs hostname * the hostname port port being used basePath base context userName user password password * * @param busTopicParams Input parameters object @@ -126,7 +126,7 @@ public class JerseyClient implements HttpClient { return new X509Certificate[0]; } - }}, new SecureRandom()); + } }, new SecureRandom()); clientBuilder = ClientBuilder.newBuilder().sslContext(sslContext).hostnameVerifier((host, session) -> true); } else { diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServerFactory.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServerFactory.java index b98ed180..488512f9 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServerFactory.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/HttpServletServerFactory.java @@ -179,33 +179,41 @@ class IndexedHttpServletServerFactory implements HttpServletServerFactory { continue; } - String hostName = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String hostName = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_HOST_SUFFIX); - String contextUriPath = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String contextUriPath = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_CONTEXT_URIPATH_SUFFIX); - String userName = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String userName = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_AUTH_USERNAME_SUFFIX); - String password = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String password = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_AUTH_PASSWORD_SUFFIX); - String authUriPath = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String authUriPath = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_AUTH_URIPATH_SUFFIX); - String restClasses = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String restClasses = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_REST_CLASSES_SUFFIX); - String filterClasses = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." - + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_FILTER_CLASSES_SUFFIX); + final String filterClasses = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_FILTER_CLASSES_SUFFIX); - String restPackages = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String restPackages = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_REST_PACKAGES_SUFFIX); - String restUriPath = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + + final String restUriPath = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_HTTP_REST_URIPATH_SUFFIX); - String managedString = properties.getProperty(PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + final String managedString = properties.getProperty( + PolicyEndPointProperties.PROPERTY_HTTP_SERVER_SERVICES + "." + serviceName + PolicyEndPointProperties.PROPERTY_MANAGED_SUFFIX); boolean managed = true; if (managedString != null && !managedString.isEmpty()) { @@ -233,14 +241,15 @@ class IndexedHttpServletServerFactory implements HttpServletServerFactory { aaf = Boolean.parseBoolean(aafString); } - HttpServletServer service = build(serviceName, https, hostName, servicePort, contextUriPath, swagger, managed); + HttpServletServer service = build(serviceName, https, hostName, servicePort, + contextUriPath, swagger, managed); /* authentication method either AAF or HTTP Basic Auth */ if (aaf) { service.addFilterClass(contextUriPath, CadiFilter.class.getCanonicalName()); } else if (userName != null && !userName.isEmpty() && password != null && !password.isEmpty()) { - service.setBasicAuthentication(userName, password, authUriPath); + service.setBasicAuthentication(userName, password, authUriPath); } if (filterClasses != null && !filterClasses.isEmpty()) { diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/aaf/AafAuthFilter.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/aaf/AafAuthFilter.java index 5f6bb544..df1f6044 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/aaf/AafAuthFilter.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/aaf/AafAuthFilter.java @@ -40,5 +40,6 @@ public abstract class AafAuthFilter extends AuthorizationFilter { } protected abstract String getPermissionType(HttpServletRequest request); + protected abstract String getPermissionInstance(HttpServletRequest request); } diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/internal/JettyServletServer.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/internal/JettyServletServer.java index 62fa0526..ebac41ef 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/internal/JettyServletServer.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/http/server/internal/JettyServletServer.java @@ -198,7 +198,7 @@ public abstract class JettyServletServer implements HttpServletServer, Runnable /** * Returns the https connector. * - * @return + * @return the server connector */ public ServerConnector httpsConnector() { SslContextFactory sslContextFactory = new SslContextFactory(); diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/report/HealthCheckReport.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/report/HealthCheckReport.java index 147dda76..fa2f3d23 100644 --- a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/report/HealthCheckReport.java +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/report/HealthCheckReport.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2018 Ericsson. 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. @@ -123,9 +124,6 @@ public class HealthCheckReport { this.message = message; } - /** - * {@inheritDoc} - */ @Override public String toString() { final StringBuilder builder = new StringBuilder(); diff --git a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/http/server/test/HttpClientTest.java b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/http/server/test/HttpClientTest.java index 5ffde38e..c5204ae3 100644 --- a/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/http/server/test/HttpClientTest.java +++ b/policy-endpoints/src/test/java/org/onap/policy/common/endpoints/http/server/test/HttpClientTest.java @@ -318,12 +318,12 @@ public class HttpClientTest { server.waitedStart(10000); } - final HttpClient clientPAP = HttpClient.factory.get("PAP"); - final Response response = clientPAP.get(); + final HttpClient clientPap = HttpClient.factory.get("PAP"); + final Response response = clientPap.get(); assertTrue(response.getStatus() == 200); - final HttpClient clientPDP = HttpClient.factory.get("PDP"); - final Response response2 = clientPDP.get("test"); + final HttpClient clientPdp = HttpClient.factory.get("PDP"); + final Response response2 = clientPdp.get("test"); assertTrue(response2.getStatus() == 500); } diff --git a/pom.xml b/pom.xml index 52941288..97df8bcb 100644 --- a/pom.xml +++ b/pom.xml @@ -272,15 +272,14 @@ with minor changes --> onap-checkstyle/onap-java-style.xml - ${project.build.sourceDirectory}/src/main/java + ${project.build.sourceDirectory} true true true - checkstyle-suppressions.xml true - true + true warning diff --git a/utils-test/src/main/java/org/onap/policy/common/utils/io/Serializer.java b/utils-test/src/main/java/org/onap/policy/common/utils/io/Serializer.java index 31e0b850..600bbd39 100644 --- a/utils-test/src/main/java/org/onap/policy/common/utils/io/Serializer.java +++ b/utils-test/src/main/java/org/onap/policy/common/utils/io/Serializer.java @@ -124,6 +124,13 @@ public class Serializer { oos.writeObject(object); } + /** + * Read the object. + * + * @param ois input stream + * @return the object + * @throws IOException throws IO exception if cannot read + */ public Object readObject(ObjectInputStream ois) throws IOException { try { return ois.readObject(); diff --git a/utils/src/main/java/org/onap/policy/common/utils/validation/ToStringTester.java b/utils/src/main/java/org/onap/policy/common/utils/validation/ToStringTester.java index 9e73a3f4..ee303eb0 100644 --- a/utils/src/main/java/org/onap/policy/common/utils/validation/ToStringTester.java +++ b/utils/src/main/java/org/onap/policy/common/utils/validation/ToStringTester.java @@ -1,6 +1,7 @@ /*- * ============LICENSE_START======================================================= * Copyright (C) 2018 Ericsson. 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. @@ -39,21 +40,21 @@ import org.hamcrest.Matcher; @SuppressWarnings("rawtypes") public class ToStringTester implements Tester { - private final Matcher m; + private final Matcher matcher; public ToStringTester() { - m = anything(); + matcher = anything(); } - public ToStringTester(final Matcher m) { - this.m = m; + public ToStringTester(final Matcher matcher) { + this.matcher = matcher; } @SuppressWarnings("unchecked") @Override public void run(final PojoClass pojoClass) { final Class clazz = pojoClass.getClazz(); - if (anyOf(m).matches(clazz)) { + if (anyOf(matcher).matches(clazz)) { final Object classInstance = ValidationHelper.getBasicInstance(pojoClass); Affirm.affirmFalse("Found default toString output", -- cgit 1.2.3-korg