From a156cf3cbad6512510ae9a02a13c0408f901c734 Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Mon, 5 Aug 2019 15:27:16 -0400 Subject: Fix sonar issues in drools-pdp Address sonar issue, "Move constants to a class or enum", by moving them from interfaces to classes: ActiveStandbyFeatureApi StateManagementFeatureApi PolicyResourceLockFeatureApi PolicySessionFeatureApi DroolsController DroolsControllerFeatureApi PolicyControllerFeatureApi PolicyEngineFeatureApi HealthCheck SystemPersistence EventProtocolCoder PolicyController PolicyEngine TestTransaction MdcTransaction Address sonar issue, "Move constants to a class or enum", by change the interface to a class: DroolsProperties Address sonar issue, "Override the "equals" method in this class", by adding equals & hashCode to: DroolsPdpEntity DroolsPdpImpl Use lombok for a number of getters & setters. Address sonar issue, "Define a constant instead of duplicating this literal" in: DroolsPdpsElectionHandler JpaDroolsPdpsConnector MavenDroolsController GenericEventProtocolCoder GsonProtocolCoderToolset RestManager Address sonar issue, "Remove the parentheses around the parameter" in: MavenDroolsController Address sonar issue, "Replace this lambda with a method reference" in: LifecycleFsm Address sonar issue, "Move this constructor to comply with Java Code Conventions" in: LifecycleStateRunning Address sonar issue, "Replace this 'switch' statement by 'if' statements to increase readability", as specified in: PolicyEngineManager Address sonar issue, "Rename field to prevent any misunderstanding/clash with field" in: MdcTransactionImpl Address sonar issue, "Either log or rethrow this exception", in: RestManager Address sonar issue, "Rename this constant name to" uppercase, by replacing enums with static lists in: RestManager Addressed review comments: Fixed license dates. Renamed getSiteName/setSiteName methods to getSite/setSite in the interface to match the field names in the implementation classes. Renamed *Instance classes to *Constants. Next round of review comments. Change-Id: I1c26af9f194833dd773f2b25dc5f60cde163201c Issue-ID: POLICY-1968 Signed-off-by: Jim Hahn --- api-state-management/pom.xml | 19 +++--- .../statemanagement/StateManagementFeatureApi.java | 40 ------------- .../StateManagementFeatureApiConstants.java | 70 ++++++++++++++++++++++ 3 files changed, 82 insertions(+), 47 deletions(-) create mode 100644 api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java (limited to 'api-state-management') diff --git a/api-state-management/pom.xml b/api-state-management/pom.xml index c02542e2..1685cbcb 100644 --- a/api-state-management/pom.xml +++ b/api-state-management/pom.xml @@ -42,15 +42,20 @@ - org.onap.policy.drools-pdp - policy-core - ${project.version} - provided + org.onap.policy.drools-pdp + policy-core + ${project.version} + provided - org.onap.policy.common - integrity-monitor - ${policy.common.version} + org.onap.policy.common + integrity-monitor + ${policy.common.version} + + + org.projectlombok + lombok + provided diff --git a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java b/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java index dcb784e3..d2c7b390 100644 --- a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java +++ b/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java @@ -21,14 +21,10 @@ package org.onap.policy.drools.statemanagement; import java.util.Observer; - import javax.validation.constraints.NotNull; - import org.onap.policy.common.capabilities.Lockable; import org.onap.policy.common.im.AllSeemsWellException; -import org.onap.policy.common.im.StateManagement; import org.onap.policy.common.utils.services.OrderedService; -import org.onap.policy.common.utils.services.OrderedServiceImpl; /** * This interface provides a way to invoke optional features at various points in the code. At @@ -38,42 +34,6 @@ import org.onap.policy.common.utils.services.OrderedServiceImpl; */ public interface StateManagementFeatureApi extends OrderedService, Lockable { - public static final String LOCKED = StateManagement.LOCKED; - public static final String UNLOCKED = StateManagement.UNLOCKED; - public static final String ENABLED = StateManagement.ENABLED; - public static final String DISABLED = StateManagement.DISABLED; - public static final String ENABLE_NOT_FAILED = StateManagement.ENABLE_NOT_FAILED_ACTION; - public static final String DISABLE_FAILED = StateManagement.DISABLE_FAILED_ACTION; - public static final String FAILED = StateManagement.FAILED; - public static final String DEPENDENCY = StateManagement.DEPENDENCY; - public static final String DEPENDENCY_FAILED = StateManagement.DEPENDENCY_FAILED; - public static final String DISABLE_DEPENDENCY = StateManagement.DISABLE_DEPENDENCY_ACTION; - public static final String ENABLE_NO_DEPENDENCY = StateManagement.ENABLE_NO_DEPENDENCY_ACTION; - public static final String NULL_VALUE = StateManagement.NULL_VALUE; - public static final String DO_LOCK = StateManagement.LOCK_ACTION; - public static final String DO_UNLOCK = StateManagement.UNLOCK_ACTION; - public static final String DO_PROMOTE = StateManagement.PROMOTE_ACTION; - public static final String DO_DEMOTE = StateManagement.DEMOTE_ACTION; - public static final String HOT_STANDBY = StateManagement.HOT_STANDBY; - public static final String COLD_STANDBY = StateManagement.COLD_STANDBY; - public static final String PROVIDING_SERVICE = StateManagement.PROVIDING_SERVICE; - - public static final String ADMIN_STATE = StateManagement.ADMIN_STATE; - public static final String OPERATION_STATE = StateManagement.OPERATION_STATE; - public static final String AVAILABLE_STATUS = StateManagement.AVAILABLE_STATUS; - public static final String STANDBY_STATUS = StateManagement.STANDBY_STATUS; - - public static final Boolean ALLSEEMSWELL_STATE = Boolean.TRUE; - public static final Boolean ALLNOTWELL_STATE = Boolean.FALSE; - - public static final int SEQ_NUM = 0; - /** - * 'FeatureAPI.impl.getList()' returns an ordered list of objects implementing the 'FeatureAPI' - * interface. - */ - public static OrderedServiceImpl impl = - new OrderedServiceImpl<>(StateManagementFeatureApi.class); - /** * ALL SEEMS/NOT WELL This interface is used to support the concept of All Seems/Not Well. It * provides a way for client code to indicate to the DroolsPDPIntegrityMonitor that an event has diff --git a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java b/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java new file mode 100644 index 00000000..be51a502 --- /dev/null +++ b/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java @@ -0,0 +1,70 @@ +/*- + * ============LICENSE_START======================================================= + * policy-core + * ================================================================================ + * Copyright (C) 2019 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. + * 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. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.drools.statemanagement; + +import lombok.Getter; +import org.onap.policy.common.im.StateManagement; +import org.onap.policy.common.utils.services.OrderedServiceImpl; + +public class StateManagementFeatureApiConstants { + + public static final String LOCKED = StateManagement.LOCKED; + public static final String UNLOCKED = StateManagement.UNLOCKED; + public static final String ENABLED = StateManagement.ENABLED; + public static final String DISABLED = StateManagement.DISABLED; + public static final String ENABLE_NOT_FAILED = StateManagement.ENABLE_NOT_FAILED_ACTION; + public static final String DISABLE_FAILED = StateManagement.DISABLE_FAILED_ACTION; + public static final String FAILED = StateManagement.FAILED; + public static final String DEPENDENCY = StateManagement.DEPENDENCY; + public static final String DEPENDENCY_FAILED = StateManagement.DEPENDENCY_FAILED; + public static final String DISABLE_DEPENDENCY = StateManagement.DISABLE_DEPENDENCY_ACTION; + public static final String ENABLE_NO_DEPENDENCY = StateManagement.ENABLE_NO_DEPENDENCY_ACTION; + public static final String NULL_VALUE = StateManagement.NULL_VALUE; + public static final String DO_LOCK = StateManagement.LOCK_ACTION; + public static final String DO_UNLOCK = StateManagement.UNLOCK_ACTION; + public static final String DO_PROMOTE = StateManagement.PROMOTE_ACTION; + public static final String DO_DEMOTE = StateManagement.DEMOTE_ACTION; + public static final String HOT_STANDBY = StateManagement.HOT_STANDBY; + public static final String COLD_STANDBY = StateManagement.COLD_STANDBY; + public static final String PROVIDING_SERVICE = StateManagement.PROVIDING_SERVICE; + + public static final String ADMIN_STATE = StateManagement.ADMIN_STATE; + public static final String OPERATION_STATE = StateManagement.OPERATION_STATE; + public static final String AVAILABLE_STATUS = StateManagement.AVAILABLE_STATUS; + public static final String STANDBY_STATUS = StateManagement.STANDBY_STATUS; + + public static final Boolean ALLSEEMSWELL_STATE = Boolean.TRUE; + public static final Boolean ALLNOTWELL_STATE = Boolean.FALSE; + + public static final int SEQ_NUM = 0; + + /** + * 'FeatureAPI.impl.getList()' returns an ordered list of objects implementing the 'FeatureAPI' + * interface. + */ + @Getter + private static final OrderedServiceImpl impl = + new OrderedServiceImpl<>(StateManagementFeatureApi.class); + + private StateManagementFeatureApiConstants() { + // do nothing + } +} -- cgit 1.2.3-korg