From 1bab60c2a752ad50844465d6db1f28b8a8d776ff Mon Sep 17 00:00:00 2001 From: jhh Date: Thu, 10 Feb 2022 13:34:40 -0600 Subject: remove unused state-management related modules Issue-ID: POLICY-3922 Signed-off-by: jhh Change-Id: Ie8164a482cce4598c621b58af612ab3a45d848ae --- .../drools/activestandby/ActiveStandbyFeature.java | 227 ----- .../activestandby/ActiveStandbyProperties.java | 76 -- .../policy/drools/activestandby/DroolsPdp.java | 50 -- .../drools/activestandby/DroolsPdpEntity.java | 79 -- .../policy/drools/activestandby/DroolsPdpImpl.java | 58 -- .../drools/activestandby/DroolsPdpObject.java | 83 -- .../drools/activestandby/DroolsPdpsConnector.java | 64 -- .../activestandby/DroolsPdpsElectionHandler.java | 973 --------------------- .../onap/policy/drools/activestandby/Factory.java | 40 - .../activestandby/JpaDroolsPdpsConnector.java | 565 ------------ .../PmStandbyStateChangeNotifier.java | 310 ------- .../drools/activestandby/ThreadRunningChecker.java | 27 - 12 files changed, 2552 deletions(-) delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyProperties.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdp.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpImpl.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpObject.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsConnector.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/Factory.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/JpaDroolsPdpsConnector.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PmStandbyStateChangeNotifier.java delete mode 100644 feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ThreadRunningChecker.java (limited to 'feature-active-standby-management/src/main/java') diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java deleted file mode 100644 index e3125a5f..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyFeature.java +++ /dev/null @@ -1,227 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2021 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.activestandby; - -import java.io.IOException; -import java.util.HashMap; -import java.util.Map; -import javax.persistence.Persistence; -import org.eclipse.persistence.config.PersistenceUnitProperties; -import org.onap.policy.common.im.MonitorTime; -import org.onap.policy.drools.core.PolicySessionFeatureApi; -import org.onap.policy.drools.features.PolicyEngineFeatureApi; -import org.onap.policy.drools.statemanagement.StateManagementFeatureApi; -import org.onap.policy.drools.statemanagement.StateManagementFeatureApiConstants; -import org.onap.policy.drools.system.PolicyEngine; -import org.onap.policy.drools.system.PolicyEngineConstants; -import org.onap.policy.drools.utils.PropertyUtil; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * If this feature is supported, there is a single instance of it. - * It adds persistence to Drools sessions, but it is also intertwined with - * active/standby state management and IntegrityMonitor. For now, they are - * all treated as a single feature, but it would be nice to separate them. - * - *

The bulk of the code here was once in other classes, such as - * 'PolicyContainer' and 'Main'. It was moved here as part of making this - * a separate optional feature. - */ -public class ActiveStandbyFeature implements ActiveStandbyFeatureApi, - PolicySessionFeatureApi, PolicyEngineFeatureApi { - // get an instance of logger - private static final Logger logger = - LoggerFactory.getLogger(ActiveStandbyFeature.class); - - private static DroolsPdp myPdp; - private static Object myPdpSync = new Object(); - private static DroolsPdpsElectionHandler electionHandler; - - private StateManagementFeatureApi stateManagementFeature; - - public static final int SEQ_NUM = 1; - - - /*========================*/ - /* 'FeatureAPI' interface */ - /*========================*/ - - /** - * {@inheritDoc}. - */ - @Override - public int getSequenceNumber() { - return SEQ_NUM; - } - - /** - * {@inheritDoc}. - */ - @Override - public void globalInit(String[] args, String configDir) { - // This must come first since it initializes myPdp - initializePersistence(configDir); - - for (StateManagementFeatureApi feature : StateManagementFeatureApiConstants.getImpl().getList()) { - if (feature.getResourceName().equals(myPdp.getPdpId())) { - logger.debug("ActiveStandbyFeature.globalInit: Found StateManagementFeature" - + " with resourceName: {}", myPdp.getPdpId()); - stateManagementFeature = feature; - break; - } - } - if (stateManagementFeature == null) { - logger.debug("ActiveStandbyFeature failed to initialize. " - + "Unable to get instance of StateManagementFeatureApi " - + "with resourceID: {}", myPdp.getPdpId()); - logger.error("ActiveStandbyFeature failed to initialize. " - + "Unable to get instance of StateManagementFeatureApi " - + "with resourceID: {}", myPdp.getPdpId()); - // - // Cannot add observer since stateManagementFeature is null - // - return; - } - - - - //Create an instance of the Observer - var pmNotifier = new PmStandbyStateChangeNotifier(); - - //Register the PMStandbyStateChangeNotifier Observer - stateManagementFeature.addObserver(pmNotifier); - logger.debug("ActiveStandbyFeature.globalInit() exit"); - } - - - /** - * {@inheritDoc}. - */ - @Override - public boolean afterStart(PolicyEngine engine) { - // ASSERTION: engine == PolicyEngine.manager - PolicyEngineConstants.getManager().lock(); - return false; - } - - /** - * Read in the persistence properties, determine whether persistence is - * enabled or disabled, and initialize persistence if enabled. - */ - private static void initializePersistence(String configDir) { - //Get the Active Standby properties - try { - var activeStandbyProperties = - PropertyUtil.getProperties(configDir + "/feature-active-standby-management.properties"); - ActiveStandbyProperties.initProperties(activeStandbyProperties); - logger.info("initializePersistence: ActiveStandbyProperties success"); - } catch (IOException e) { - logger.error("ActiveStandbyFeature: initializePersistence ActiveStandbyProperties", e); - } - - var conn = getDroolsPdpsConnector("activeStandbyPU"); - String resourceName = ActiveStandbyProperties.getProperty(ActiveStandbyProperties.NODE_NAME); - if (resourceName == null) { - throw new NullPointerException(); - } - - /* - * In a JUnit test environment, one or more PDPs may already have been - * inserted in the DB, so we need to check for this. - */ - DroolsPdp existingPdp = conn.getPdp(resourceName); - if (existingPdp != null) { - logger.info("Found existing PDP record, pdpId={} isDesignated={}, updatedDate={}", - existingPdp.getPdpId(), existingPdp.isDesignated(), existingPdp.getUpdatedDate()); - myPdp = existingPdp; - } - - synchronized (myPdpSync) { - if (myPdp == null) { - - myPdp = new DroolsPdpImpl(resourceName, false, 4, MonitorTime.getInstance().getDate()); - } - String siteName = ActiveStandbyProperties.getProperty(ActiveStandbyProperties.SITE_NAME); - if (siteName == null) { - siteName = ""; - } else { - siteName = siteName.trim(); - } - myPdp.setSite(siteName); - if (electionHandler == null) { - electionHandler = new DroolsPdpsElectionHandler(conn, myPdp); - } - } - logger.info("\n\nThis controller is a standby, waiting to be chosen as primary...\n\n"); - } - - - /** - * Moved code to instantiate a JpaDroolsPdpsConnector object from main() to - * this method, so it can also be accessed from StandbyStateChangeNotifier - * class. - * - * @param pu string - * @return connector object - */ - public static DroolsPdpsConnector getDroolsPdpsConnector(String pu) { - - Map propMap = new HashMap<>(); - propMap.put(PersistenceUnitProperties.JDBC_DRIVER, - ActiveStandbyProperties.getProperty(ActiveStandbyProperties.DB_DRIVER)); - propMap.put(PersistenceUnitProperties.JDBC_URL, - ActiveStandbyProperties.getProperty(ActiveStandbyProperties.DB_URL)); - propMap.put(PersistenceUnitProperties.JDBC_USER, - ActiveStandbyProperties.getProperty(ActiveStandbyProperties.DB_USER)); - propMap.put(PersistenceUnitProperties.JDBC_PASSWORD, - ActiveStandbyProperties.getProperty(ActiveStandbyProperties.DB_PWD)); - propMap.put(PersistenceUnitProperties.TARGET_DATABASE, - ActiveStandbyProperties.getProperty(ActiveStandbyProperties.DB_TYPE)); - - var emf = Persistence.createEntityManagerFactory(pu, propMap); - return new JpaDroolsPdpsConnector(emf); - } - - /** - * {@inheritDoc}. - */ - @Override - public String getPdpdNowActive() { - return electionHandler.getPdpdNowActive(); - } - - /** - * {@inheritDoc}. - */ - @Override - public String getPdpdLastActive() { - return electionHandler.getPdpdLastActive(); - } - - /** - * {@inheritDoc}. - */ - @Override - public String getResourceName() { - return myPdp.getPdpId(); - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyProperties.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyProperties.java deleted file mode 100644 index 30c8171e..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ActiveStandbyProperties.java +++ /dev/null @@ -1,76 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2019, 2021 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.activestandby; - -import java.util.Properties; -import lombok.AccessLevel; -import lombok.Getter; -import lombok.NoArgsConstructor; -import org.eclipse.persistence.config.PersistenceUnitProperties; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -@NoArgsConstructor(access = AccessLevel.PRIVATE) -public final class ActiveStandbyProperties { - // get an instance of logger - private static final Logger logger = LoggerFactory.getLogger(ActiveStandbyProperties.class); - - public static final String PDP_CHECK_INVERVAL = "pdp.checkInterval"; - public static final String PDP_UPDATE_INTERVAL = "pdp.updateInterval"; - public static final String PDP_TIMEOUT = "pdp.timeout"; - public static final String PDP_INITIAL_WAIT_PERIOD = "pdp.initialWait"; - - public static final String NODE_NAME = "resource.name"; - public static final String SITE_NAME = "site_name"; - - /* - * feature-active-standby-management.properties parameter key values - */ - public static final String DB_DRIVER = PersistenceUnitProperties.JDBC_DRIVER; - public static final String DB_URL = PersistenceUnitProperties.JDBC_URL; - public static final String DB_USER = PersistenceUnitProperties.JDBC_USER; - public static final String DB_PWD = PersistenceUnitProperties.JDBC_PASSWORD; - public static final String DB_TYPE = PersistenceUnitProperties.TARGET_DATABASE; - - @Getter - private static Properties properties = null; - - /** - * Initialize the parameter values from the droolsPersitence.properties file values. - * - *

This is designed so that the Properties object is obtained from properties - * file and then is passed to this method to initialize the value of the parameters. - * This allows the flexibility of JUnit tests using getProperties(filename) to get the - * properties while runtime methods can use getPropertiesFromClassPath(filename). - * - * @param prop properties - */ - public static void initProperties(Properties prop) { - logger.info("ActiveStandbyProperties.initProperties(Properties): entry"); - logger.info("\n\nActiveStandbyProperties.initProperties: Properties = \n{}\n\n", prop); - - properties = prop; - } - - public static String getProperty(String key) { - return properties.getProperty(key); - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdp.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdp.java deleted file mode 100644 index 12c75929..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdp.java +++ /dev/null @@ -1,50 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-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.activestandby; - -import java.util.Date; - -public interface DroolsPdp { - - String getPdpId(); - - boolean isDesignated(); - - int getPriority(); - - Date getUpdatedDate(); - - void setDesignated(boolean isDesignated); - - void setUpdatedDate(Date updatedDate); - - int comparePriority(DroolsPdp other); - - int comparePriority(DroolsPdp other, String previousSite); - - String getSite(); - - void setSite(String site); - - Date getDesignatedDate(); - - void setDesignatedDate(Date designatedDate); -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java deleted file mode 100644 index 526200fc..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpEntity.java +++ /dev/null @@ -1,79 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2019, 2021 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.activestandby; - -import java.io.Serializable; -import java.util.Date; -import javax.persistence.Column; -import javax.persistence.Entity; -import javax.persistence.Id; -import javax.persistence.NamedQuery; -import javax.persistence.Temporal; -import javax.persistence.TemporalType; -import lombok.EqualsAndHashCode; -import lombok.Getter; -import lombok.Setter; -import org.onap.policy.common.im.MonitorTime; - -@Entity -//@Table(name="DroolsPdpEntity") - -@NamedQuery(name = "DroolsPdpEntity.findAll", query = "SELECT e FROM DroolsPdpEntity e ") -@NamedQuery(name = "DroolsPdpEntity.deleteAll", query = "DELETE FROM DroolsPdpEntity WHERE 1=1") -@Getter -@Setter -@EqualsAndHashCode(onlyExplicitlyIncluded = true, callSuper = true) -public class DroolsPdpEntity extends DroolsPdpObject implements Serializable { - - private static final long serialVersionUID = 1L; - - @Id - @Column(name = "pdpId", nullable = false) - private String pdpId = "-1"; - - @Column(name = "designated", nullable = false) - private boolean designated = false; - - @Column(name = "priority", nullable = false) - private int priority = 0; - - @Temporal(TemporalType.TIMESTAMP) - @Column(name = "updatedDate", nullable = false) - private Date updatedDate; - - @Temporal(TemporalType.TIMESTAMP) - @Column(name = "designatedDate", nullable = false) - private Date designatedDate; - - @Column(name = "site", nullable = true, length = 50) - private String site; - - /** - * Constructor. - */ - public DroolsPdpEntity() { - updatedDate = MonitorTime.getInstance().getDate(); - //When this is translated to a TimeStamp in MySQL, it assumes the date is relative - //to the local timezone. So, a value of Date(0) is actually Dec 31 18:00:00 CST 1969 - //which is an invalid value for the MySql TimeStamp - designatedDate = new Date(864000000); - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpImpl.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpImpl.java deleted file mode 100644 index dac35ea3..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpImpl.java +++ /dev/null @@ -1,58 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2019, 2021 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.activestandby; - -import java.util.Date; -import lombok.EqualsAndHashCode; -import lombok.Getter; -import lombok.Setter; - -@Getter -@Setter -@EqualsAndHashCode(onlyExplicitlyIncluded = true, callSuper = true) -public class DroolsPdpImpl extends DroolsPdpObject { - - private boolean designated; - private int priority; - private Date updatedDate; - private Date designatedDate; - private String pdpId; - private String site; - - /** - * Contructor. - * - * @param pdpId ID for the PDP - * @param designated is designated - * @param priority priority - * @param updatedDate date updated - */ - public DroolsPdpImpl(String pdpId, boolean designated, int priority, Date updatedDate) { - this.pdpId = pdpId; - this.designated = designated; - this.priority = priority; - this.updatedDate = updatedDate; - //When this is translated to a TimeStamp in MySQL, it assumes the date is relative - //to the local timezone. So, a value of Date(0) is actually Dec 31 18:00:00 CST 1969 - //which is an invalid value for the MySql TimeStamp - this.designatedDate = new Date(864000000); - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpObject.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpObject.java deleted file mode 100644 index c8971130..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpObject.java +++ /dev/null @@ -1,83 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2019, 2021 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.activestandby; - - -public abstract class DroolsPdpObject implements DroolsPdp { - - @Override - public boolean equals(Object other) { - if (other instanceof DroolsPdp) { - return this.getPdpId().equals(((DroolsPdp) other).getPdpId()); - } else { - return false; - } - } - - @Override - public int hashCode() { - final var prime = 31; - var result = 1; - result = prime * result + (this.getPdpId() == null ? 0 : this.getPdpId().hashCode()); - return result; - } - - private int nullSafeCompare(String one, String two) { - if (one != null) { - if (two != null) { - return one.compareTo(two); - - } else { - return 1; - } - - } else if (two != null) { - return -1; - - } else { - return 0; - } - } - - @Override - public int comparePriority(DroolsPdp other) { - return commonCompare(other); - } - - @Override - public int comparePriority(DroolsPdp other, String previousSite) { - if (previousSite == null || previousSite.isEmpty()) { - return comparePriority(other); - } - return commonCompare(other); - } - - private int commonCompare(DroolsPdp other) { - if (nullSafeCompare(this.getSite(), other.getSite()) == 0) { - if (this.getPriority() != other.getPriority()) { - return this.getPriority() - other.getPriority(); - } - return this.getPdpId().compareTo(other.getPdpId()); - } else { - return nullSafeCompare(this.getSite(), other.getSite()); - } - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsConnector.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsConnector.java deleted file mode 100644 index 6e06272c..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsConnector.java +++ /dev/null @@ -1,64 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-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.activestandby; - -import java.util.Collection; - -public interface DroolsPdpsConnector { - - - //return a list of PDPs, NOT including this PDP - Collection getDroolsPdps(); - - void update(DroolsPdp pdp); - - //determines if the DroolsPdp parameter is considered "current" or expired - //(has it been too long since the Pdp sent an update) - boolean isPdpCurrent(DroolsPdp pdp); - - // Updates DESIGNATED boolean in PDP record. - void setDesignated(DroolsPdp pdp, boolean designated); - - // Marks droolspdpentity.DESIGNATED=false, so another PDP-D will go active. - void standDownPdp(String pdpId); - - // This is used in a JUnit test environment to manually - // insert a PDP - void insertPdp(DroolsPdp pdp); - - // This is used in a JUnit test environment to manually - // delete a PDP - void deletePdp(String pdpId); - - // This is used in a JUnit test environment to manually - // clear the droolspdpentity table. - void deleteAllPdps(); - - // This is used in a JUnit test environment to manually - // get a PDP - DroolsPdpEntity getPdp(String pdpId); - - // Used by DroolsPdpsElectionHandler to determine if the currently designated - // PDP has failed. - boolean hasDesignatedPdpFailed(Collection pdps); - - -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java deleted file mode 100644 index ff4b21df..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/DroolsPdpsElectionHandler.java +++ /dev/null @@ -1,973 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2021 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.activestandby; - -import java.util.ArrayList; -import java.util.Collection; -import java.util.Date; -import java.util.List; -import java.util.Objects; -import java.util.TimerTask; -import lombok.Getter; -import lombok.Setter; -import org.onap.policy.common.im.MonitorTime; -import org.onap.policy.common.im.StateManagement; -import org.onap.policy.common.utils.time.CurrentTime; -import org.onap.policy.drools.statemanagement.StateManagementFeatureApi; -import org.onap.policy.drools.statemanagement.StateManagementFeatureApiConstants; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -public class DroolsPdpsElectionHandler implements ThreadRunningChecker { - private static final String RUN_PRIMARY_MSG = "DesignatedWaiter.run mostRecentPrimary = {}"; - - // get an instance of logger - private static final Logger logger = LoggerFactory.getLogger(DroolsPdpsElectionHandler.class); - - /* - * Must be static, so it can be referenced by JpaDroolsPdpsConnector, - * without requiring a reference to the election handler instantiation. - */ - private static DroolsPdp myPdp; - - @Setter - private static boolean unitTesting = false; - @Setter - private static boolean stalled = false; - - private DroolsPdpsConnector pdpsConnector; - private Object checkWaitTimerLock = new Object(); - private Object designationWaiterLock = new Object(); - - private Date waitTimerLastRunDate; - - // The interval between runs of the DesignationWaiter - private int pdpUpdateInterval; - - private volatile boolean isDesignated; - - @Getter - private String pdpdNowActive; - @Getter - private String pdpdLastActive; - - /* - * Start allSeemsWell with a value of null so that, on the first run - * of the checkWaitTimer it will set the value in IntegrityMonitor - * regardless of whether it needs to be set to true or false. - */ - private Boolean allSeemsWell = null; - - private StateManagementFeatureApi stateManagementFeature; - - private final CurrentTime currentTime = MonitorTime.getInstance(); - - /** - * Constructor. - * - * @param pdps connectors - * @param myPdp pdp - */ - public DroolsPdpsElectionHandler(DroolsPdpsConnector pdps, DroolsPdp myPdp) { - if (pdps == null) { - logger.error("DroolsPdpsElectinHandler(): pdpsConnector==null"); - throw new IllegalArgumentException("DroolsPdpsElectinHandler(): pdpsConnector==null"); - } - if (myPdp == null) { - logger.error("DroolsPdpsElectinHandler(): droolsPdp==null"); - throw new IllegalArgumentException("DroolsPdpsElectinHandler(): DroolsPdp==null"); - } - - pdpdNowActive = null; - pdpdLastActive = null; - this.pdpsConnector = pdps; - setMyPdp(myPdp); - this.isDesignated = false; - - // The interval between checks of the DesignationWaiter to be sure it is running. - var pdpCheckInterval = 3000; - try { - pdpCheckInterval = Integer.parseInt(ActiveStandbyProperties.getProperty( - ActiveStandbyProperties.PDP_CHECK_INVERVAL)); - } catch (Exception e) { - logger.error("Could not get pdpCheckInterval property. Using default {}", pdpCheckInterval, e); - } - pdpUpdateInterval = 2000; - try { - pdpUpdateInterval = Integer.parseInt(ActiveStandbyProperties.getProperty( - ActiveStandbyProperties.PDP_UPDATE_INTERVAL)); - } catch (Exception e) { - logger.error("Could not get pdpUpdateInterval property. Using default {} ", pdpUpdateInterval, e); - } - - var now = currentTime.getDate(); - - // Retrieve the ms since the epoch - final long nowMs = now.getTime(); - - // Create the timer which will update the updateDate in DroolsPdpEntity table. - // This is the heartbeat - var updateWorker = Factory.getInstance().makeTimer(); - - // Schedule the TimerUpdateClass to run at 100 ms and run at pdpCheckInterval ms thereafter - // NOTE: The first run of the TimerUpdateClass results in myPdp being added to the - // drools droolsPdpEntity table. - updateWorker.scheduleAtFixedRate(new TimerUpdateClass(), 100, pdpCheckInterval); - - // Create the timer which will run the election algorithm - var waitTimer = Factory.getInstance().makeTimer(); - - // Schedule it to start in startMs ms - // (so it will run after the updateWorker and run at pdpUpdateInterval ms thereafter - long startMs = getDWaiterStartMs(); - var designationWaiter = new DesignationWaiter(); - waitTimer.scheduleAtFixedRate(designationWaiter, startMs, pdpUpdateInterval); - waitTimerLastRunDate = new Date(nowMs + startMs); - - //Get the StateManagementFeature instance - - for (StateManagementFeatureApi feature : StateManagementFeatureApiConstants.getImpl().getList()) { - if (feature.getResourceName().equals(myPdp.getPdpId())) { - logger.debug("DroolsPdpsElectionHandler: Found StateManagementFeature" - + " with resourceName: {}", myPdp.getPdpId()); - stateManagementFeature = feature; - break; - } - } - if (stateManagementFeature == null) { - logger.error("DroolsPdpsElectionHandler failed to initialize. " - + "Unable to get instance of StateManagementFeatureApi " - + "with resourceID: {}", myPdp.getPdpId()); - } - } - - private static void setMyPdp(DroolsPdp myPdp) { - DroolsPdpsElectionHandler.myPdp = myPdp; - } - - /** - * When the JpaDroolsPdpsConnector.standDown() method is invoked, it needs - * access to myPdp, so it can keep its designation status in sync with the - * DB. - * - * @param designated is designated value - */ - public static void setMyPdpDesignated(boolean designated) { - logger.debug("setMyPdpDesignated: designated= {}", designated); - myPdp.setDesignated(designated); - } - - private class DesignationWaiter extends TimerTask { - // get an instance of logger - private final Logger logger = LoggerFactory.getLogger(DesignationWaiter.class); - - @Override - public void run() { - try { - logger.debug("DesignatedWaiter.run: Entering"); - - //This is for testing the checkWaitTimer - if (unitTesting && stalled) { - logger.debug("DesignatedWaiter.run: isUnitTesting = {} isStalled = {}", - unitTesting, stalled); - return; - } - - synchronized (designationWaiterLock) { - - logger.debug("DesignatedWaiter.run: Entering synchronized block"); - - //It is possible that multiple PDPs are designated lead. So, we will make a list of all designated - //PDPs and then decide which one really should be designated at the end. - List listOfDesignated = new ArrayList<>(); - - Collection pdps = pdpsConnector.getDroolsPdps(); - - logger.debug("DesignatedWaiter.run: pdps.size= {}", pdps.size()); - - //This is only true if all designated PDPs have failed - allPdpsFailed(pdps, listOfDesignated); - - /* - * We have checked the four combinations of isDesignated and isCurrent. Where appropriate, - * we added the PDPs to the potential list of designated pdps - * - * We need to give priority to pdps on the same site that is currently being used - * First, however, we must sanitize the list of designated to make sure their are - * only designated members or non-designated members. There should not be both in - * the list. Because there are real time delays, it is possible that both types could - * be on the list. - */ - - listOfDesignated = santizeDesignatedList(listOfDesignated); - - /* - * We need to figure out the last pdp that was the primary so we can get the last site - * name and the last session numbers. We need to create a "dummy" droolspdp since - * it will be used in later comparisons and cannot be null. - */ - - DroolsPdp mostRecentPrimary = computeMostRecentPrimary(pdps, listOfDesignated); - - if (mostRecentPrimary != null) { - pdpdLastActive = mostRecentPrimary.getPdpId(); - } - - - /* - * It is possible to get here with more than one pdp designated and providing service. This normally - * occurs when there is a race condition with multiple nodes coming up at the same time. If that is - * the case we must determine which one is the one that should be designated and which one should - * be demoted. - * - * It is possible to have 0, 1, 2 or more but not all, or all designated. - * If we have one designated and current, we chose it and are done - * If we have 2 or more, but not all, we must determine which one is in the same site as - * the previously designated pdp. - */ - DroolsPdp designatedPdp = computeDesignatedPdp(listOfDesignated, mostRecentPrimary); - - if (designatedPdp == null) { - logger.warn("WARNING: DesignatedWaiter.run: No viable PDP found to be Designated. " - + "designatedPdp still null."); - designateNoPdp(); - return; - } - - pdpdNowActive = designatedPdp.getPdpId(); - - if (pdpdNowActive.equals(myPdp.getPdpId())) { - logger.debug("DesignatedWaiter.run: designatedPdp is PDP={}", myPdp.getPdpId()); - designateMyPdp(); - return; - } - - isDesignated = false; - - } // end synchronized - logger.debug("DesignatedWaiter.run: myPdp: {}; Returning, isDesignated= {}", - isDesignated, myPdp.getPdpId()); - - var tmpDate = currentTime.getDate(); - logger.debug("DesignatedWaiter.run (end of run) waitTimerLastRunDate = {}", tmpDate); - - waitTimerLastRunDate = tmpDate; - myPdp.setUpdatedDate(waitTimerLastRunDate); - pdpsConnector.update(myPdp); - - } catch (Exception e) { - logger.error("DesignatedWaiter.run caught an unexpected exception: ", e); - } - } // end run - - private void allPdpsFailed(Collection pdps, List listOfDesignated) { - boolean designatedPdpHasFailed = pdpsConnector.hasDesignatedPdpFailed(pdps); - logger.debug("DesignatedWaiter.run: designatedPdpHasFailed= {}", designatedPdpHasFailed); - for (DroolsPdp pdp : pdps) { - logger.debug("DesignatedWaiter.run: evaluating pdp ID: {}", pdp.getPdpId()); - - /* - * Note: side effect of isPdpCurrent is that any stale but - * designated PDPs will be marked as un-designated. - */ - boolean isCurrent = pdpsConnector.isPdpCurrent(pdp); - - /* - * We can't use stateManagement.getStandbyStatus() here, because - * we need the standbyStatus, not for this PDP, but for the PDP - * being processed by this loop iteration. - */ - String standbyStatus = stateManagementFeature.getStandbyStatus(pdp.getPdpId()); - if (standbyStatus == null) { - // Treat this case as a cold standby -- if we - // abort here, no sessions will be created in a - // single-node test environment. - standbyStatus = StateManagement.COLD_STANDBY; - } - logger.debug("DesignatedWaiter.run: PDP= {}, isCurrent= {}", pdp.getPdpId(), isCurrent); - - adjustPdp(pdp, isCurrent, designatedPdpHasFailed, standbyStatus, listOfDesignated); - - - } // end pdps loop - } - - private void adjustPdp(DroolsPdp pdp, boolean isCurrent, boolean designatedPdpHasFailed, String standbyStatus, - List listOfDesignated) { - /* - * There are 4 combinations of isDesignated and isCurrent. We will examine each one in-turn - * and evaluate the each pdp in the list of pdps against each combination. - */ - if (pdp.isDesignated()) { - /* - * This is the first combination of isDesignated and isCurrent - */ - if (isCurrent) { - pdpDesignatedCurrent(pdp, standbyStatus, listOfDesignated); - - /* - * The second combination of isDesignated and isCurrent - * - * PDP is designated but not current; it has failed. - * So we stand it down (it doesn't matter what - * its standbyStatus is). None of these go on the list. - */ - } else { - logger.debug("INFO: DesignatedWaiter.run: PDP= {} is currently " - + "designated but is not current; " - + "it has failed. Standing down. standbyStatus= {}", - pdp.getPdpId(), standbyStatus); - pdpDesignatedNotCurrent(pdp); - } - - } else { - // NOT designated - - - /* - * The third combination of isDesignated and isCurrent - * /* - * If a PDP is not currently designated but is providing service - * (erroneous, but recoverable) or hot standby - * we can add it to the list of possible designated if all the designated have failed - */ - if (isCurrent) { - pdpNotDesignatedCurrent(pdp, designatedPdpHasFailed, standbyStatus, - listOfDesignated); - - /* - * The fourth combination of isDesignated and isCurrent - * - * We are not going to put any of these on the list since it appears they have failed. - * - */ - } else { - logger.debug("INFO: DesignatedWaiter.run: PDP= {} " - + "designated= {}, current= {}, " - + "designatedPdpHasFailed= {}, " - + "standbyStatus= {}", pdp.getPdpId(), - pdp.isDesignated(), false, designatedPdpHasFailed, standbyStatus); - pdpNotDesignatedNotCurrent(pdp, standbyStatus); - } - } - } - - private void pdpDesignatedCurrent(DroolsPdp pdp, String standbyStatus, List listOfDesignated) { - //It is current, but it could have a standbystatus=coldstandby / hotstandby - //If so, we need to stand it down and demote it - if (!standbyStatus.equals(StateManagement.PROVIDING_SERVICE)) { - if (pdp.getPdpId().equals(myPdp.getPdpId())) { - logger.debug("\n\nDesignatedWaiter.run: myPdp {} is current and designated, " - + "butstandbystatus is not providingservice. " - + " Executing stateManagement.demote()" + "\n\n", myPdp.getPdpId()); - // So, we must demote it - try { - demoteMyPdp(pdp, standbyStatus); - } catch (Exception e) { - logger.error("DesignatedWaiter.run: myPdp: {} " - + "Caught Exception attempting to demote myPdp," - + "message= {}", myPdp.getPdpId(), e); - } - } else { - // Don't demote a remote PDP that is current. It should catch itself - logger.debug("\n\nDesignatedWaiter.run: myPdp {} is current and designated, " - + "but standbystatus is not providingservice. " - + " Cannot execute stateManagement.demote() " - + "since it it is not myPdp\n\n", - myPdp.getPdpId()); - } - - } else { - // If we get here, it is ok to be on the list - logger.debug("DesignatedWaiter.run: PDP= {} is designated, " - + "current and {} Noting PDP as " - + "designated, standbyStatus= {}", - pdp.getPdpId(), standbyStatus, standbyStatus); - listOfDesignated.add(pdp); - } - } - - private void demoteMyPdp(DroolsPdp pdp, String standbyStatus) throws Exception { - /* - * Keep the order like this. StateManagement is last since it triggers - * controller shutdown. This will change isDesignated and it can enter another - * if-combination below - */ - pdpsConnector.standDownPdp(pdp.getPdpId()); - myPdp.setDesignated(false); - isDesignated = false; - if (!(standbyStatus.equals(StateManagement.HOT_STANDBY) - || standbyStatus.equals(StateManagement.COLD_STANDBY))) { - /* - * Only demote it if it appears it has not already been demoted. Don't worry - * about synching with the topic endpoint states. That is done by the - * refreshStateAudit - */ - stateManagementFeature.demote(); - } - } - - private void pdpDesignatedNotCurrent(DroolsPdp pdp) { - /* - * Changes designated to 0 but it is still potentially providing service. - * Will affect isDesignated, so, it can enter an if-combination below - */ - pdpsConnector.standDownPdp(pdp.getPdpId()); - - //need to change standbystatus to coldstandby - if (pdp.getPdpId().equals(myPdp.getPdpId())) { - logger.debug("\n\nDesignatedWaiter.run: myPdp {} is not Current. " - + " Executing stateManagement.disableFailed()\n\n", myPdp.getPdpId()); - // We found that myPdp is designated but not current - // So, we must cause it to disableFail - try { - myPdp.setDesignated(false); - pdpsConnector.setDesignated(myPdp, false); - isDesignated = false; - stateManagementFeature.disableFailed(); - } catch (Exception e) { - logger.error("DesignatedWaiter.run: myPdp: {} Caught Exception " - + "attempting to disableFail myPdp {}, message= {}", - myPdp.getPdpId(), myPdp.getPdpId(), e); - } - } else { //it is a remote PDP that is failed - logger.debug("\n\nDesignatedWaiter.run: PDP {} is not Current. " - + " Executing stateManagement.disableFailed(otherResourceName)\n\n", - pdp.getPdpId()); - // We found a PDP is designated but not current - // We already called standdown(pdp) which will change designated to false - // Now we need to disableFail it to get its states in synch. The standbyStatus - // should equal coldstandby - try { - stateManagementFeature.disableFailed(pdp.getPdpId()); - } catch (Exception e) { - logger.error("DesignatedWaiter.run: for PDP {} Caught Exception attempting to " - + "disableFail({}), message= {}", - pdp.getPdpId(), pdp.getPdpId(), e); - } - - } - } - - private void pdpNotDesignatedCurrent(DroolsPdp pdp, boolean designatedPdpHasFailed, String standbyStatus, - List listOfDesignated) { - if (!(StateManagement.HOT_STANDBY.equals(standbyStatus) - || StateManagement.COLD_STANDBY.equals(standbyStatus))) { - logger.debug("\n\nDesignatedWaiter.run: PDP {}" - + " is NOT designated but IS current and" - + " has a standbystatus= {}", pdp.getPdpId(), standbyStatus); - // Since it is current, we assume it can adjust its own state. - // We will demote if it is myPdp - if (pdp.getPdpId().equals(myPdp.getPdpId())) { - //demote it - logger.debug("DesignatedWaiter.run: PDP {} going to " - + "setDesignated = false and calling stateManagement.demote", - pdp.getPdpId()); - try { - //Keep the order like this. - //StateManagement is last since it triggers controller shutdown - pdpsConnector.setDesignated(myPdp, false); - myPdp.setDesignated(false); - isDesignated = false; - //This is definitely not a redundant call. - //It is attempting to correct a problem - stateManagementFeature.demote(); - //recheck the standbystatus - standbyStatus = stateManagementFeature.getStandbyStatus(pdp.getPdpId()); - } catch (Exception e) { - logger.error("DesignatedWaiter.run: myPdp: {} Caught Exception " - + "attempting to demote myPdp {}, message = {}", myPdp.getPdpId(), - myPdp.getPdpId(), e); - } - - } - } - if (StateManagement.HOT_STANDBY.equals(standbyStatus) && designatedPdpHasFailed) { - //add it to the list - logger.debug("INFO: DesignatedWaiter.run: PDP= {}" - + " is not designated but is {} and designated PDP " - + "has failed. standbyStatus= {}", pdp.getPdpId(), - standbyStatus, standbyStatus); - listOfDesignated.add(pdp); - } - } - - private void pdpNotDesignatedNotCurrent(DroolsPdp pdp, String standbyStatus) { - if (StateManagement.COLD_STANDBY.equals(standbyStatus)) { - return; - } - - //stand it down - //disableFail it - pdpsConnector.standDownPdp(pdp.getPdpId()); - if (pdp.getPdpId().equals(myPdp.getPdpId())) { - /* - * I don't actually know how this condition could - * happen, but if it did, we would want to declare it - * failed. - */ - logger.debug("\n\nDesignatedWaiter.run: myPdp {} is !current and !designated, " - + " Executing stateManagement.disableFailed()\n\n", - myPdp.getPdpId()); - // So, we must disableFail it - try { - //Keep the order like this. - //StateManagement is last since it triggers controller shutdown - pdpsConnector.setDesignated(myPdp, false); - myPdp.setDesignated(false); - isDesignated = false; - stateManagementFeature.disableFailed(); - } catch (Exception e) { - logger.error("DesignatedWaiter.run: myPdp: {} Caught Exception attempting to " - + "disableFail myPdp {}, message= {}", - myPdp.getPdpId(), myPdp.getPdpId(), e); - } - } else { //it is remote - logger.debug("\n\nDesignatedWaiter.run: myPdp {} is !current and !designated, " - + " Executing stateManagement.disableFailed({})\n\n", - myPdp.getPdpId(), pdp.getPdpId()); - // We already called standdown(pdp) which will change designated to false - // Now we need to disableFail it to get its states in sync. - // StandbyStatus = coldstandby - try { - stateManagementFeature.disableFailed(pdp.getPdpId()); - } catch (Exception e) { - logger.error("DesignatedWaiter.run: for PDP {}" - + " Caught Exception attempting to disableFail({})" - + ", message=", pdp.getPdpId(), pdp.getPdpId(), e); - } - } - } - - private void designateNoPdp() { - // Just to be sure the parameters are correctly set - myPdp.setDesignated(false); - pdpsConnector.setDesignated(myPdp, false); - isDesignated = false; - - waitTimerLastRunDate = currentTime.getDate(); - logger.debug("DesignatedWaiter.run (designatedPdp == null) waitTimerLastRunDate = {}", - waitTimerLastRunDate); - myPdp.setUpdatedDate(waitTimerLastRunDate); - pdpsConnector.update(myPdp); - } - - private void designateMyPdp() { - /* - * update function expects myPdp.isDesignated to be true. - */ - try { - //Keep the order like this. StateManagement is last since it triggers controller init - myPdp.setDesignated(true); - myPdp.setDesignatedDate(currentTime.getDate()); - pdpsConnector.setDesignated(myPdp, true); - isDesignated = true; - String standbyStatus = stateManagementFeature.getStandbyStatus(); - if (!standbyStatus.equals(StateManagement.PROVIDING_SERVICE)) { - /* - * Only call promote if it is not already in the right state. Don't worry about - * synching the lower level topic endpoint states. That is done by the - * refreshStateAudit. - */ - stateManagementFeature.promote(); - } - } catch (Exception e) { - logger.error("ERROR: DesignatedWaiter.run: Caught Exception attempting to promote PDP={}" - + ", message=", myPdp.getPdpId(), e); - myPdp.setDesignated(false); - pdpsConnector.setDesignated(myPdp, false); - isDesignated = false; - //If you can't promote it, demote it - try { - String standbyStatus = stateManagementFeature.getStandbyStatus(); - if (!(standbyStatus.equals(StateManagement.HOT_STANDBY) - || standbyStatus.equals(StateManagement.COLD_STANDBY))) { - /* - * Only call demote if it is not already in the right state. Don't worry about - * synching the lower level topic endpoint states. That is done by the - * refreshStateAudit. - */ - stateManagementFeature.demote(); - } - } catch (Exception e1) { - logger.error("ERROR: DesignatedWaiter.run: Caught StandbyStatusException " - + "attempting to promote then demote PDP={}, message=", - myPdp.getPdpId(), e1); - } - - } - waitTimerLastRunDate = currentTime.getDate(); - logger.debug("DesignatedWaiter.run (designatedPdp.getPdpId().equals(myPdp.getPdpId())) " - + "waitTimerLastRunDate = {}", waitTimerLastRunDate); - myPdp.setUpdatedDate(waitTimerLastRunDate); - pdpsConnector.update(myPdp); - } - } - - /** - * Sanitize designated list. - * - * @param listOfDesignated list of designated pdps - * @return list of drools pdps - */ - public List santizeDesignatedList(List listOfDesignated) { - - var containsDesignated = false; - var containsHotStandby = false; - List listForRemoval = new ArrayList<>(); - for (DroolsPdp pdp : listOfDesignated) { - logger.debug("DesignatedWaiter.run sanitizing: pdp = {}" - + " isDesignated = {}", pdp.getPdpId(), pdp.isDesignated()); - if (pdp.isDesignated()) { - containsDesignated = true; - } else { - containsHotStandby = true; - listForRemoval.add(pdp); - } - } - if (containsDesignated && containsHotStandby) { - //remove the hot standby from the list - listOfDesignated.removeAll(listForRemoval); - } - return listOfDesignated; - } - - /** - * Compute most recent primary. - * - * @param pdps collection of pdps - * @param listOfDesignated list of designated pdps - * @return drools pdp object - */ - public DroolsPdp computeMostRecentPrimary(Collection pdps, List listOfDesignated) { - boolean containsDesignated = listOfDesignated.stream().anyMatch(DroolsPdp::isDesignated); - - DroolsPdp mostRecentPrimary = new DroolsPdpImpl(null, true, 1, new Date(0)); - mostRecentPrimary.setSite(null); - logger.debug("DesignatedWaiter.run listOfDesignated.size() = {}", listOfDesignated.size()); - - if (listOfDesignated.size() <= 1) { - logger.debug("DesignatedWainter.run: listOfDesignated.size <=1"); - //Only one or none is designated or hot standby. Choose the latest designated date - mostRecentPrimary = getLatestDesignated(pdps, mostRecentPrimary); - - } else if (listOfDesignated.size() == pdps.size()) { - logger.debug("DesignatedWainter.run: listOfDesignated.size = pdps.size() which is {}", pdps.size()); - //They are all designated or all hot standby. - mostRecentPrimary = getBestDesignated(pdps, containsDesignated); - - } else { - logger.debug("DesignatedWainter.run: Some but not all are designated or hot standby. "); - logger.debug("DesignatedWainter.run: containsDesignated = {}", containsDesignated); - //Some but not all are designated or hot standby. - if (containsDesignated) { - /* - * The list only contains designated. This is a problem. It is most likely a race - * condition that resulted in two thinking they should be designated. Choose the - * site with the latest designated date for the pdp not included on the designated list. - * This should be the site that had the last designation before this race condition - * occurred. - */ - mostRecentPrimary = getLatestUndesignated(pdps, mostRecentPrimary, listOfDesignated); - - } else { - //The list only contains hot standby. Choose the site of the latest designated date - mostRecentPrimary = getLatestDesignated(pdps, mostRecentPrimary); - } - } - return mostRecentPrimary; - } - - private DroolsPdp getBestDesignated(Collection pdps, boolean containsDesignated) { - DroolsPdp mostRecentPrimary; - mostRecentPrimary = null; - for (DroolsPdp pdp : pdps) { - if (mostRecentPrimary == null) { - mostRecentPrimary = pdp; - continue; - } - if (containsDesignated) { //Choose the site of the first designated date - if (pdp.getDesignatedDate().compareTo(mostRecentPrimary.getDesignatedDate()) < 0) { - mostRecentPrimary = pdp; - logger.debug(RUN_PRIMARY_MSG, mostRecentPrimary.getPdpId()); - } - } else { //Choose the site with the latest designated date - if (pdp.getDesignatedDate().compareTo(mostRecentPrimary.getDesignatedDate()) > 0) { - mostRecentPrimary = pdp; - logger.debug(RUN_PRIMARY_MSG, mostRecentPrimary.getPdpId()); - } - } - } - return mostRecentPrimary; - } - - private DroolsPdp getLatestUndesignated(Collection pdps, DroolsPdp mostRecentPrimary, - List listOfDesignated) { - for (DroolsPdp pdp : pdps) { - if (listOfDesignated.contains(pdp)) { - continue; //Don't consider this entry - } - if (pdp.getDesignatedDate().compareTo(mostRecentPrimary.getDesignatedDate()) > 0) { - mostRecentPrimary = pdp; - logger.debug(RUN_PRIMARY_MSG, mostRecentPrimary.getPdpId()); - } - } - return mostRecentPrimary; - } - - private DroolsPdp getLatestDesignated(Collection pdps, DroolsPdp mostRecentPrimary) { - for (DroolsPdp pdp : pdps) { - logger.debug("DesignatedWaiter.run pdp = {}" - + " pdp.getDesignatedDate() = {}", - pdp.getPdpId(), pdp.getDesignatedDate()); - if (pdp.getDesignatedDate().compareTo(mostRecentPrimary.getDesignatedDate()) > 0) { - mostRecentPrimary = pdp; - logger.debug(RUN_PRIMARY_MSG, mostRecentPrimary.getPdpId()); - } - } - return mostRecentPrimary; - } - - /** - * Compue designated pdp. - * - * @param listOfDesignated list of designated pdps - * @param mostRecentPrimary most recent primary pdpd - * @return drools pdp object - */ - public DroolsPdp computeDesignatedPdp(List listOfDesignated, DroolsPdp mostRecentPrimary) { - if (listOfDesignated.isEmpty()) { - logger.debug("\nDesignatedWaiter.run: myPdp: {} listOfDesignated is: EMPTY.", myPdp.getPdpId()); - return null; - } - - if (listOfDesignated.size() == 1) { - logger.debug("\nDesignatedWaiter.run: myPdp: {} listOfDesignated " - + "has ONE entry. PDP ID: {}", myPdp.getPdpId(), listOfDesignated.get(0).getPdpId()); - return listOfDesignated.get(0); - } - - logger.debug("DesignatedWaiter.run: myPdp: {} listOfDesignated.size(): {}", myPdp.getPdpId(), - listOfDesignated.size()); - var data = new DesignatedData(); - for (DroolsPdp pdp : listOfDesignated) { - DroolsPdp rejectedPdp; - - // We need to determine if another PDP is the lowest priority - if (Objects.equals(pdp.getSite(), mostRecentPrimary.getSite())) { - rejectedPdp = data.compareSameSite(pdp); - } else { - rejectedPdp = data.compareDifferentSite(pdp); - } - // If the rejectedPdp is myPdp, we need to stand it down and demote it. Each pdp is responsible - // for demoting itself - if (rejectedPdp != null && Objects.equals(rejectedPdp.getPdpId(), myPdp.getPdpId())) { - logger.debug("\n\nDesignatedWaiter.run: myPdp: {} listOfDesignated myPdp ID: {}" - + " is NOT the lowest priority. Executing stateManagement.demote()\n\n", - myPdp.getPdpId(), - myPdp.getPdpId()); - // We found that myPdp is on the listOfDesignated and it is not the lowest priority - // So, we must demote it - demoteMyPdp(); - } - } - - DroolsPdp lowestPriorityPdp = data.getLowestPriority(); - - //now we have a valid value for lowestPriorityPdp - logger.debug("\n\nDesignatedWaiter.run: myPdp: {} listOfDesignated " - + "found the LOWEST priority pdp ID: {} " - + " It is now the designatedPpd from the perspective of myPdp ID: {} \n\n", - myPdp.getPdpId(), lowestPriorityPdp.getPdpId(), myPdp); - return lowestPriorityPdp; - - } - - private class DesignatedData { - private DroolsPdp lowestPrioritySameSite = null; - private DroolsPdp lowestPriorityDifferentSite = null; - - private DroolsPdp compareSameSite(DroolsPdp pdp) { - if (lowestPrioritySameSite == null) { - if (lowestPriorityDifferentSite != null) { - //we need to reject lowestPriorityDifferentSite - DroolsPdp rejectedPdp = lowestPriorityDifferentSite; - lowestPriorityDifferentSite = pdp; - return rejectedPdp; - } - lowestPrioritySameSite = pdp; - return null; - } else { - if (pdp.getPdpId().equals((lowestPrioritySameSite.getPdpId()))) { - return null; //nothing to compare - } - if (pdp.comparePriority(lowestPrioritySameSite) < 0) { - logger.debug("\nDesignatedWaiter.run: myPdp {} listOfDesignated pdp ID: {}" - + " has lower priority than pdp ID: {}", myPdp.getPdpId(), pdp.getPdpId(), - lowestPrioritySameSite.getPdpId()); - //we need to reject lowestPrioritySameSite - DroolsPdp rejectedPdp = lowestPrioritySameSite; - lowestPrioritySameSite = pdp; - return rejectedPdp; - } else { - //we need to reject pdp and keep lowestPrioritySameSite - logger.debug("\nDesignatedWaiter.run: myPdp {} listOfDesignated pdp ID: {} " - + " has higher priority than pdp ID: {}", myPdp.getPdpId(), pdp.getPdpId(), - lowestPrioritySameSite.getPdpId()); - return pdp; - } - } - } - - private DroolsPdp compareDifferentSite(DroolsPdp pdp) { - if (lowestPrioritySameSite != null) { - //if we already have a candidate for same site, we don't want to bother with different sites - return pdp; - } else { - if (lowestPriorityDifferentSite == null) { - lowestPriorityDifferentSite = pdp; - return null; - } - if (pdp.getPdpId().equals((lowestPriorityDifferentSite.getPdpId()))) { - return null; //nothing to compare - } - if (pdp.comparePriority(lowestPriorityDifferentSite) < 0) { - logger.debug("\nDesignatedWaiter.run: myPdp {} listOfDesignated pdp ID: {}" - + " has lower priority than pdp ID: {}", myPdp.getPdpId(), pdp.getPdpId(), - lowestPriorityDifferentSite.getPdpId()); - //we need to reject lowestPriorityDifferentSite - DroolsPdp rejectedPdp = lowestPriorityDifferentSite; - lowestPriorityDifferentSite = pdp; - return rejectedPdp; - } else { - //we need to reject pdp and keep lowestPriorityDifferentSite - logger.debug("\nDesignatedWaiter.run: myPdp {} listOfDesignated pdp ID: {}" - + " has higher priority than pdp ID: {}", myPdp.getPdpId(), pdp.getPdpId(), - lowestPriorityDifferentSite.getPdpId()); - return pdp; - } - } - } - - private DroolsPdp getLowestPriority() { - return (lowestPrioritySameSite != null ? lowestPrioritySameSite : lowestPriorityDifferentSite); - } - } - - private void demoteMyPdp() { - try { - //Keep the order like this. StateManagement is last since it triggers controller shutdown - myPdp.setDesignated(false); - pdpsConnector.setDesignated(myPdp, false); - isDesignated = false; - String standbyStatus = stateManagementFeature.getStandbyStatus(); - if (!(standbyStatus.equals(StateManagement.HOT_STANDBY) - || standbyStatus.equals(StateManagement.COLD_STANDBY))) { - /* - * Only call demote if it is not already in the right state. Don't worry about - * synching the lower level topic endpoint states. That is done by the - * refreshStateAudit. - */ - stateManagementFeature.demote(); - } - } catch (Exception e) { - myPdp.setDesignated(false); - pdpsConnector.setDesignated(myPdp, false); - isDesignated = false; - logger.error("DesignatedWaiter.run: myPdp: {} Caught Exception attempting to " - + "demote myPdp {} myPdp.getPdpId(), message= {}", myPdp.getPdpId(), - e); - } - } - - private class TimerUpdateClass extends TimerTask { - - @Override - public void run() { - try { - logger.debug("TimerUpdateClass.run: entry"); - checkWaitTimer(); - } catch (Exception e) { - logger.error("TimerUpdateClass.run caught an unexpected exception: ", e); - } - logger.debug("TimerUpdateClass.run.exit"); - } - } - - @Override - public void checkThreadStatus() { - checkWaitTimer(); - } - - private void checkWaitTimer() { - synchronized (checkWaitTimerLock) { - try { - logger.debug("checkWaitTimer: entry"); - var now = currentTime.getDate(); - long nowMs = now.getTime(); - long waitTimerMs = waitTimerLastRunDate.getTime(); - - //give it 10 times leeway - if ((nowMs - waitTimerMs) > 10 * pdpUpdateInterval) { - if (allSeemsWell == null || allSeemsWell) { - allSeemsWell = false; - logger.debug("checkWaitTimer: calling allSeemsWell with ALLNOTWELL param"); - stateManagementFeature.allSeemsWell(this.getClass().getName(), - StateManagementFeatureApiConstants.ALLNOTWELL_STATE, - "DesignationWaiter/ElectionHandler has STALLED"); - } - logger.error("checkWaitTimer: nowMs - waitTimerMs = {}" - + ", exceeds 10* pdpUpdateInterval = {}" - + " DesignationWaiter is STALLED!", (nowMs - waitTimerMs), (10 * pdpUpdateInterval)); - } else if (allSeemsWell == null || !allSeemsWell) { - allSeemsWell = true; - stateManagementFeature.allSeemsWell(this.getClass().getName(), - StateManagementFeatureApiConstants.ALLSEEMSWELL_STATE, - "DesignationWaiter/ElectionHandler has RESUMED"); - logger.info("DesignationWaiter/ElectionHandler has RESUMED"); - } - logger.debug("checkWaitTimer: exit"); - } catch (Exception e) { - logger.error("checkWaitTimer: caught unexpected exception: ", e); - } - } - } - - private long getDWaiterStartMs() { - var now = currentTime.getDate(); - - // Retrieve the ms since the epoch - long nowMs = now.getTime(); - - // Time since the end of the last pdpUpdateInterval multiple - long nowModMs = nowMs % pdpUpdateInterval; - - // Time to the start of the next pdpUpdateInterval multiple - long startMs = 2 * pdpUpdateInterval - nowModMs; - - // Give the start time a minimum of a 5 second cushion - if (startMs < 5000) { - // Start at the beginning of following interval - startMs = pdpUpdateInterval + startMs; - } - return startMs; - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/Factory.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/Factory.java deleted file mode 100644 index fae70074..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/Factory.java +++ /dev/null @@ -1,40 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * ONAP - * ================================================================================ - * 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.activestandby; - -import java.util.Timer; -import lombok.AccessLevel; -import lombok.Getter; -import lombok.Setter; - -/** - * Factory for creating various objects. - */ -public class Factory { - - @Getter - @Setter(AccessLevel.PROTECTED) - private static Factory instance = new Factory(); - - public Timer makeTimer() { - return new Timer(); - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/JpaDroolsPdpsConnector.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/JpaDroolsPdpsConnector.java deleted file mode 100644 index 39386d5e..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/JpaDroolsPdpsConnector.java +++ /dev/null @@ -1,565 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2021 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.activestandby; - -import java.util.Collection; -import java.util.LinkedList; -import java.util.List; -import javax.persistence.EntityManager; -import javax.persistence.EntityManagerFactory; -import javax.persistence.FlushModeType; -import javax.persistence.LockModeType; -import lombok.AllArgsConstructor; -import org.onap.policy.common.im.MonitorTime; -import org.onap.policy.common.utils.time.CurrentTime; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -@AllArgsConstructor -public class JpaDroolsPdpsConnector implements DroolsPdpsConnector { - - private static final String SELECT_PDP_BY_ID = "SELECT p FROM DroolsPdpEntity p WHERE p.pdpId=:pdpId"; - private static final String PDP_ID_PARAM = "pdpId"; - - // get an instance of logger - private static final Logger logger = LoggerFactory.getLogger(JpaDroolsPdpsConnector.class); - private EntityManagerFactory emf; - - private final CurrentTime currentTime = MonitorTime.getInstance(); - - @Override - public Collection getDroolsPdps() { - //return a list of all the DroolsPdps in the database - var em = emf.createEntityManager(); - try { - em.getTransaction().begin(); - var droolsPdpsListQuery = em.createQuery("SELECT p FROM DroolsPdpEntity p", DroolsPdp.class); - List droolsPdpsList = droolsPdpsListQuery.setLockMode(LockModeType.NONE) - .setFlushMode(FlushModeType.COMMIT).getResultList(); - LinkedList droolsPdpsReturnList = new LinkedList<>(); - for (DroolsPdp droolsPdp : droolsPdpsList) { - //Make sure it is not a cached version - em.refresh(droolsPdp); - droolsPdpsReturnList.add(droolsPdp); - if (logger.isDebugEnabled()) { - logger.debug("getDroolsPdps: PDP= {}" - + ", isDesignated= {}" - + ", updatedDate= {}" - + ", priority= {}", droolsPdp.getPdpId(), droolsPdp.isDesignated(), - droolsPdp.getUpdatedDate(), droolsPdp.getPriority()); - } - } - try { - em.getTransaction().commit(); - } catch (Exception e) { - logger.error("Cannot commit getDroolsPdps() transaction", e); - } - return droolsPdpsReturnList; - } finally { - cleanup(em, "getDroolsPdps"); - } - } - - private boolean nullSafeEquals(Object one, Object two) { - if (one == null && two == null) { - return true; - } - if (one != null && two != null) { - return one.equals(two); - } - return false; - } - - @Override - public void update(DroolsPdp pdp) { - - logger.debug("update: Entering, pdpId={}", pdp.getPdpId()); - - //this is to update our own pdp in the database - var em = emf.createEntityManager(); - try { - em.getTransaction().begin(); - var droolsPdpsListQuery = em.createQuery(SELECT_PDP_BY_ID, DroolsPdpEntity.class); - droolsPdpsListQuery.setParameter(PDP_ID_PARAM, pdp.getPdpId()); - List droolsPdpsList = droolsPdpsListQuery.setLockMode(LockModeType.NONE) - .setFlushMode(FlushModeType.COMMIT).getResultList(); - DroolsPdpEntity droolsPdpEntity; - if (droolsPdpsList.size() == 1) { - droolsPdpEntity = droolsPdpsList.get(0); - em.refresh(droolsPdpEntity); //Make sure we have current values - var currentDate = currentTime.getDate(); - long difference = currentDate.getTime() - droolsPdpEntity.getUpdatedDate().getTime(); - //just set some kind of default here - long pdpTimeout = 15000; - try { - pdpTimeout = Long.parseLong( - ActiveStandbyProperties.getProperty(ActiveStandbyProperties.PDP_TIMEOUT)); - } catch (Exception e) { - logger.error("Could not get PDP timeout property, using default.", e); - } - boolean isCurrent = difference < pdpTimeout; - logger.debug("update: PDP= {}, isCurrent={}" - + " difference= {}" - + ", pdpTimeout= {}, designated= {}", - pdp.getPdpId(), isCurrent, difference, pdpTimeout, droolsPdpEntity.isDesignated()); - } else { - logger.debug("update: For PDP={}" - + ", instantiating new DroolsPdpEntity", pdp.getPdpId()); - droolsPdpEntity = new DroolsPdpEntity(); - em.persist(droolsPdpEntity); - droolsPdpEntity.setPdpId(pdp.getPdpId()); - } - if (droolsPdpEntity.getPriority() != pdp.getPriority()) { - droolsPdpEntity.setPriority(pdp.getPriority()); - } - if (!droolsPdpEntity.getUpdatedDate().equals(pdp.getUpdatedDate())) { - droolsPdpEntity.setUpdatedDate(pdp.getUpdatedDate()); - } - if (!nullSafeEquals(droolsPdpEntity.getSite(), pdp.getSite())) { - droolsPdpEntity.setSite(pdp.getSite()); - } - - if (droolsPdpEntity.isDesignated() != pdp.isDesignated()) { - logger.debug("update: pdpId={}" - + ", pdp.isDesignated={}" - + ", droolsPdpEntity.pdpId= {}" - + ", droolsPdpEntity.isDesignated={}", - pdp.getPdpId(), pdp.isDesignated(), - droolsPdpEntity.getPdpId(), droolsPdpEntity.isDesignated()); - droolsPdpEntity.setDesignated(pdp.isDesignated()); - //The isDesignated value is not the same and the new one == true - if (pdp.isDesignated()) { - droolsPdpEntity.setDesignatedDate(currentTime.getDate()); - } - } - em.getTransaction().commit(); - } finally { - cleanup(em, "update"); - } - - logger.debug("update: Exiting"); - - } - - /* - * Note: A side effect of this boolean method is that if the PDP is designated but not current, the - * droolspdpentity.DESIGNATED column will be set to false (the PDP will be un-designated, i.e. marked as - * being in standby mode) - */ - @Override - public boolean isPdpCurrent(DroolsPdp pdp) { - - boolean isCurrent = isCurrent(pdp); - - var em = emf.createEntityManager(); - try { - if (!isCurrent && pdp.isDesignated()) { - em.getTransaction().begin(); - var droolsPdpsListQuery = em.createQuery(SELECT_PDP_BY_ID, DroolsPdpEntity.class); - droolsPdpsListQuery.setParameter(PDP_ID_PARAM, pdp.getPdpId()); - List droolsPdpsList = droolsPdpsListQuery.setLockMode(LockModeType.NONE) - .setFlushMode(FlushModeType.COMMIT).getResultList(); - if (droolsPdpsList.size() == 1) { - logger.debug("isPdpCurrent: PDP={} designated but not current; setting designated to false", - pdp.getPdpId()); - var droolsPdpEntity = droolsPdpsList.get(0); - droolsPdpEntity.setDesignated(false); - em.getTransaction().commit(); - } else { - logger.warn("isPdpCurrent: PDP={} is designated but not current; " - + "however it does not have a DB entry, so cannot set DESIGNATED to false!", - pdp.getPdpId()); - } - } else { - logger.debug("isPdpCurrent: For PDP= {}, " - + "designated={}, isCurrent={}", pdp.getPdpId(), pdp.isDesignated(), isCurrent); - } - } catch (Exception e) { - logger.error("Could not update expired record marked as designated in the database", e); - } finally { - cleanup(em, "isPdpCurrent"); - } - return isCurrent; - - } - - @Override - public void setDesignated(DroolsPdp pdp, boolean designated) { - - logger.debug("setDesignated: Entering, pdpId={}" - + ", designated={}", pdp.getPdpId(), designated); - - EntityManager em = null; - try { - em = emf.createEntityManager(); - em.getTransaction().begin(); - var droolsPdpsListQuery = em - .createQuery(SELECT_PDP_BY_ID, DroolsPdpEntity.class); - droolsPdpsListQuery.setParameter(PDP_ID_PARAM, pdp.getPdpId()); - List droolsPdpsList = droolsPdpsListQuery.setLockMode( - LockModeType.NONE).setFlushMode(FlushModeType.COMMIT).getResultList(); - if (droolsPdpsList.size() == 1) { - var droolsPdpEntity = droolsPdpsList.get(0); - - logger.debug("setDesignated: PDP={}" - + " found, designated= {}" - + ", setting to {}", pdp.getPdpId(), droolsPdpEntity.isDesignated(), - designated); - setPdpDesignation(em, droolsPdpEntity, designated); - em.getTransaction().commit(); - } else { - logger.error("setDesignated: PDP={}" - + " not in DB; cannot update designation", pdp.getPdpId()); - } - } catch (Exception e) { - logger.error("setDesignated: Caught Exception", e); - } finally { - cleanup(em, "setDesignated"); - } - - logger.debug("setDesignated: Exiting"); - - } - - private void setPdpDesignation(EntityManager em, DroolsPdpEntity droolsPdpEntity, boolean designated) { - droolsPdpEntity.setDesignated(designated); - if (designated) { - em.refresh(droolsPdpEntity); //make sure we get the DB value - if (!droolsPdpEntity.isDesignated()) { - droolsPdpEntity.setDesignatedDate(currentTime.getDate()); - } - - } - } - - - @Override - public void standDownPdp(String pdpId) { - logger.debug("standDownPdp: Entering, pdpId={}", pdpId); - - EntityManager em = null; - try { - /* - * Start transaction. - */ - em = emf.createEntityManager(); - em.getTransaction().begin(); - - /* - * Get droolspdpentity record for this PDP and mark DESIGNATED as - * false. - */ - var droolsPdpsListQuery = em - .createQuery(SELECT_PDP_BY_ID, DroolsPdpEntity.class); - droolsPdpsListQuery.setParameter(PDP_ID_PARAM, pdpId); - List droolsPdpsList = droolsPdpsListQuery.setLockMode( - LockModeType.NONE).setFlushMode(FlushModeType.COMMIT).getResultList(); - if (droolsPdpsList.size() == 1) { - var droolsPdpEntity = droolsPdpsList.get(0); - droolsPdpEntity.setDesignated(false); - em.persist(droolsPdpEntity); - logger.debug("standDownPdp: PDP={} persisted as non-designated.", pdpId); - } else { - logger.error("standDownPdp: Missing record in droolspdpentity for pdpId={}" - + "; cannot stand down PDP", pdpId); - } - - /* - * End transaction. - */ - em.getTransaction().commit(); - cleanup(em, "standDownPdp"); - em = null; - - // Keep the election handler in sync with the DB - DroolsPdpsElectionHandler.setMyPdpDesignated(false); - - } catch (Exception e) { - logger.error("standDownPdp: Unexpected Exception attempting to mark " - + "DESIGNATED as false for droolspdpentity, pdpId={}" - + ". Cannot stand down PDP; message={}", pdpId, e.getMessage(), e); - } finally { - cleanup(em, "standDownPdp"); - } - logger.debug("standDownPdp: Exiting"); - - } - - /* - * Determines whether or not a designated PDP has failed. - * - * Note: The update method, which is run periodically by the - * TimerUpdateClass, will un-designate a PDP that is stale. - */ - @Override - public boolean hasDesignatedPdpFailed(Collection pdps) { - - logger.debug("hasDesignatedPdpFailed: Entering, pdps.size()={}", pdps.size()); - - var failed = true; - var foundDesignatedPdp = false; - - for (DroolsPdp pdp : pdps) { - - /* - * Normally, the update method will un-designate any stale PDP, but - * we check here to see if the PDP has gone stale since the update - * method was run. - * - * Even if we determine that the designated PDP is current, we keep - * going (we don't break), so we can get visibility into the other - * PDPs, when in DEBUG mode. - */ - if (pdp.isDesignated() && isCurrent(pdp)) { - logger.debug("hasDesignatedPdpFailed: Designated PDP={} is current", pdp.getPdpId()); - failed = false; - foundDesignatedPdp = true; - } else if (pdp.isDesignated() && !isCurrent(pdp)) { - logger.error("hasDesignatedPdpFailed: Designated PDP={} has failed", pdp.getPdpId()); - foundDesignatedPdp = true; - } else { - logger.debug("hasDesignatedPdpFailed: PDP={} is not designated", pdp.getPdpId()); - } - } - - logger.debug("hasDesignatedPdpFailed: Exiting and returning, foundDesignatedPdp={}", - foundDesignatedPdp); - return failed; - } - - - private boolean isCurrent(DroolsPdp pdp) { - - logger.debug("isCurrent: Entering, pdpId={}", pdp.getPdpId()); - - var current = false; - - // Return if the current PDP is considered "current" based on whatever - // time box that may be. - // If the the PDP is not current, we should mark it as not primary in - // the database - var currentDate = currentTime.getDate(); - long difference = currentDate.getTime() - - pdp.getUpdatedDate().getTime(); - // just set some kind of default here - long pdpTimeout = 15000; - try { - pdpTimeout = Long.parseLong(ActiveStandbyProperties - .getProperty(ActiveStandbyProperties.PDP_TIMEOUT)); - logger.debug("isCurrent: pdp.timeout={}", pdpTimeout); - } catch (Exception e) { - logger.error("isCurrent: Could not get PDP timeout property, using default.", e); - } - current = difference < pdpTimeout; - - logger.debug("isCurrent: Exiting, difference={}, pdpTimeout={}" - + "; returning current={}", difference, pdpTimeout, current); - - return current; - } - - - /* - * Currently this method is only used in a JUnit test environment. Gets a - * PDP record from droolspdpentity table. - */ - @Override - public DroolsPdpEntity getPdp(String pdpId) { - - logger.debug("getPdp: Entering and getting PDP with pdpId={}", pdpId); - - DroolsPdpEntity droolsPdpEntity = null; - - EntityManager em = null; - try { - em = emf.createEntityManager(); - em.getTransaction().begin(); - var droolsPdpsListQuery = em - .createQuery(SELECT_PDP_BY_ID); - droolsPdpsListQuery.setParameter(PDP_ID_PARAM, pdpId); - List droolsPdpsList = droolsPdpsListQuery.setLockMode( - LockModeType.NONE).setFlushMode(FlushModeType.COMMIT).getResultList(); - if (droolsPdpsList.size() == 1 - && droolsPdpsList.get(0) instanceof DroolsPdpEntity) { - droolsPdpEntity = (DroolsPdpEntity) droolsPdpsList.get(0); - logger.debug("getPdp: PDP={}" - + " found, isDesignated={}," - + " updatedDate={}, " - + "priority={}", pdpId, - droolsPdpEntity.isDesignated(), droolsPdpEntity.getUpdatedDate(), - droolsPdpEntity.getPriority()); - - // Make sure the droolsPdpEntity is not a cached version - em.refresh(droolsPdpEntity); - - em.getTransaction().commit(); - } else { - logger.error("getPdp: PDP={} not found!?", pdpId); - } - } catch (Exception e) { - logger.error("getPdp: Caught Exception attempting to get PDP", e); - } finally { - cleanup(em, "getPdp"); - } - - logger.debug("getPdp: Returning droolsPdpEntity={}", droolsPdpEntity); - return droolsPdpEntity; - - } - - /* - * Normally this method should only be used in a JUnit test environment. - * Manually inserts a PDP record in droolspdpentity table. - */ - @Override - public void insertPdp(DroolsPdp pdp) { - logger.debug("insertPdp: Entering and manually inserting PDP"); - - /* - * Start transaction - */ - var em = emf.createEntityManager(); - try { - em.getTransaction().begin(); - - /* - * Insert record. - */ - var droolsPdpEntity = new DroolsPdpEntity(); - em.persist(droolsPdpEntity); - droolsPdpEntity.setPdpId(pdp.getPdpId()); - droolsPdpEntity.setDesignated(pdp.isDesignated()); - droolsPdpEntity.setPriority(pdp.getPriority()); - droolsPdpEntity.setUpdatedDate(pdp.getUpdatedDate()); - droolsPdpEntity.setSite(pdp.getSite()); - - /* - * End transaction. - */ - em.getTransaction().commit(); - } finally { - cleanup(em, "insertPdp"); - } - logger.debug("insertPdp: Exiting"); - - } - - /* - * Normally this method should only be used in a JUnit test environment. - * Manually deletes all PDP records in droolspdpentity table. - */ - @Override - public void deleteAllPdps() { - - logger.debug("deleteAllPdps: Entering"); - - /* - * Start transaction - */ - var em = emf.createEntityManager(); - try { - em.getTransaction().begin(); - - var droolsPdpsListQuery = em - .createQuery("SELECT p FROM DroolsPdpEntity p"); - @SuppressWarnings("unchecked") - List droolsPdpsList = droolsPdpsListQuery.setLockMode( - LockModeType.NONE).setFlushMode(FlushModeType.COMMIT).getResultList(); - logger.debug("deleteAllPdps: Deleting {} PDPs", droolsPdpsList.size()); - for (DroolsPdp droolsPdp : droolsPdpsList) { - String pdpId = droolsPdp.getPdpId(); - deletePdp(pdpId); - } - - /* - * End transaction. - */ - em.getTransaction().commit(); - } finally { - cleanup(em, "deleteAllPdps"); - } - logger.debug("deleteAllPdps: Exiting"); - - } - - /* - * Normally this method should only be used in a JUnit test environment. - * Manually deletes a PDP record in droolspdpentity table. - */ - @Override - public void deletePdp(String pdpId) { - logger.debug("deletePdp: Entering and manually deleting pdpId={}", pdpId); - - /* - * Start transaction - */ - var em = emf.createEntityManager(); - try { - em.getTransaction().begin(); - - /* - * Delete record. - */ - var droolsPdpEntity = em.find(DroolsPdpEntity.class, pdpId); - if (droolsPdpEntity != null) { - logger.debug("deletePdp: Removing PDP"); - em.remove(droolsPdpEntity); - } else { - logger.debug("deletePdp: PDP with ID={} not currently in DB", pdpId); - } - - /* - * End transaction. - */ - em.getTransaction().commit(); - } finally { - cleanup(em, "deletePdp"); - } - logger.debug("deletePdp: Exiting"); - - } - - /* - * Close the specified EntityManager, rolling back any pending transaction - * - * @param em the EntityManager to close ('null' is OK) - * @param method the invoking Java method (used for log messages) - */ - private static void cleanup(EntityManager em, String method) { - if (em != null && em.isOpen()) { - if (em.getTransaction().isActive()) { - // there is an active EntityTransaction -- roll it back - try { - em.getTransaction().rollback(); - } catch (Exception e) { - logger.error("{}: Caught Exception attempting to rollback EntityTransaction", method, e); - } - } - - // now, close the EntityManager - try { - em.close(); - } catch (Exception e) { - logger.error("{}: Caught Exception attempting to close EntityManager", method, e); - } - } - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PmStandbyStateChangeNotifier.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PmStandbyStateChangeNotifier.java deleted file mode 100644 index 1756246b..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/PmStandbyStateChangeNotifier.java +++ /dev/null @@ -1,310 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * Copyright (C) 2017-2019, 2021 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.activestandby; - -import java.util.Timer; -import java.util.TimerTask; -import lombok.Getter; -import org.onap.policy.common.im.MonitorTime; -import org.onap.policy.common.im.StateChangeNotifier; -import org.onap.policy.common.im.StateManagement; -import org.onap.policy.common.utils.time.CurrentTime; -import org.onap.policy.drools.system.PolicyEngine; -import org.onap.policy.drools.system.PolicyEngineConstants; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/* - * Some background: - * - * Originally, there was a "StandbyStateChangeNotifier" that belonged to policy-core, and this class's - * handleStateChange() method used to take care of invoking conn.standDownPdp(). - * - * But testing revealed that when a state change to hot standby - * occurred from a demote() operation, first the PMStandbyStateChangeNotifier.handleStateChange() method - * would be invoked and then the StandbyStateChangeNotifier.handleStateChange() method would be invoked, - * and this ordering was creating the following problem: - * - * When PMStandbyStateChangeNotifier.handleStateChange() was invoked it would take a long time to finish, - * because it would result in SingleThreadedUebTopicSource.stop() being invoked, which can potentially do a - * 5 second sleep for each controller being stopped. - * - * Meanwhile, as these controller stoppages and their associated sleeps were occurring, the election handler - * would discover the demoted PDP in hotstandby (but still designated!) and promote it, resulting in the - * standbyStatus going from hotstandby to providingservice. So then, by the time that - * PMStandbyStateChangeNotifier.handleStateChange() finished its work and - * StandbyStateChangeNotifier.handleStateChange() started executing, the standbyStatus was no longer hotstandby - * (as effected by the demote), but providingservice (as reset by the election handling logic) and - * conn.standDownPdp() would not get called! - * - * To fix this bug, we consolidated StandbyStateChangeNotifier and PMStandbyStateChangeNotifier, - * with the standDownPdp() always - * being invoked prior to the TopicEndpoint.manager.lock(). In this way, when the election handling logic is invoked - * during the controller stoppages, the PDP is in hotstandby and the standdown occurs. - * - */ -public class PmStandbyStateChangeNotifier extends StateChangeNotifier { - // get an instance of logger - private static final Logger logger = LoggerFactory.getLogger(PmStandbyStateChangeNotifier.class); - private Timer delayActivateTimer; - private boolean isWaitingForActivation; - private long startTimeWaitingForActivationMs; - private long waitInterval; - private boolean isNowActivating; - @Getter - private String previousStandbyStatus; - private final CurrentTime currentTime = MonitorTime.getInstance(); - private final Factory timerFactory = Factory.getInstance(); - public static final String NONE = "none"; - public static final String UNSUPPORTED = "unsupported"; - public static final String HOTSTANDBY_OR_COLDSTANDBY = "hotstandby_or_coldstandby"; - - /** - * Constructor. - * - */ - public PmStandbyStateChangeNotifier() { - var pdpUpdateInterval = - Integer.parseInt(ActiveStandbyProperties.getProperty(ActiveStandbyProperties.PDP_UPDATE_INTERVAL)); - isWaitingForActivation = false; - startTimeWaitingForActivationMs = currentTime.getMillis(); - // delay the activate so the DesignatedWaiter can run twice - give it an extra 2 seconds - waitInterval = 2 * pdpUpdateInterval + 2000L; - isNowActivating = false; - previousStandbyStatus = PmStandbyStateChangeNotifier.NONE; - } - - @Override - public void handleStateChange() { - /* - * A note on synchronization: This method is not synchronized because the caller, - * stateManagememt, has synchronize all of its methods. Only one stateManagement operation - * can occur at a time. Thus, only one handleStateChange() call will ever be made at a time. - */ - logger.debug("handleStateChange: Entering, message={}, standbyStatus={}", super.getMessage(), - super.getStateManagement().getStandbyStatus()); - String standbyStatus = super.getStateManagement().getStandbyStatus(); - String pdpId = ActiveStandbyProperties.getProperty(ActiveStandbyProperties.NODE_NAME); - - logger.debug("handleStateChange: previousStandbyStatus = {}; standbyStatus = {}", - previousStandbyStatus, standbyStatus); - - if (standbyStatus == null || standbyStatus.equals(StateManagement.NULL_VALUE)) { - logger.debug("handleStateChange: standbyStatus is null; standing down PDP={}", pdpId); - standDownPdpNull(pdpId); - - } else if (standbyStatus.equals(StateManagement.HOT_STANDBY) - || standbyStatus.equals(StateManagement.COLD_STANDBY)) { - logger.debug("handleStateChange: standbyStatus={}; standing down PDP={}", standbyStatus, pdpId); - standDownPdp(pdpId, standbyStatus); - - } else if (standbyStatus.equals(StateManagement.PROVIDING_SERVICE)) { - logger.debug("handleStateChange: standbyStatus= {} scheduling activation of PDP={}", standbyStatus, - pdpId); - schedulePdpActivation(pdpId, standbyStatus); - - } else { - logger.error("handleStateChange: Unsupported standbyStatus={}; standing down PDP={}", standbyStatus, pdpId); - standDownPdpUnsupported(pdpId, standbyStatus); - } - - logger.debug("handleStateChange: Exiting"); - } - - private void standDownPdpNull(String pdpId) { - if (previousStandbyStatus.equals(StateManagement.NULL_VALUE)) { - // We were just here and did this successfully - logger.debug("handleStateChange: " - + "Is returning because standbyStatus is null and was previously 'null'; PDP={}", - pdpId); - return; - } - - isWaitingForActivation = false; - try { - logger.debug("handleStateChange: null: cancelling delayActivationTimer."); - cancelTimer(); - // Only want to lock the endpoints, not the controllers. - getPolicyEngineManager().deactivate(); - // The operation was fully successful, but you cannot assign it a real null value - // because later we might try to execute previousStandbyStatus.equals() and get - // a null pointer exception. - previousStandbyStatus = StateManagement.NULL_VALUE; - } catch (Exception e) { - logger.warn("handleStateChange: standbyStatus == null caught exception: ", e); - } - } - - private void standDownPdp(String pdpId, String standbyStatus) { - if (previousStandbyStatus.equals(PmStandbyStateChangeNotifier.HOTSTANDBY_OR_COLDSTANDBY)) { - // We were just here and did this successfully - logger.debug("handleStateChange: Is returning because standbyStatus is {}" - + " and was previously {}; PDP= {}", standbyStatus, previousStandbyStatus, pdpId); - return; - } - - isWaitingForActivation = false; - try { - logger.debug("handleStateChange: HOT_STNDBY || COLD_STANDBY: cancelling delayActivationTimer."); - cancelTimer(); - // Only want to lock the endpoints, not the controllers. - getPolicyEngineManager().deactivate(); - // The operation was fully successful - previousStandbyStatus = PmStandbyStateChangeNotifier.HOTSTANDBY_OR_COLDSTANDBY; - } catch (Exception e) { - logger.warn("handleStateChange: standbyStatus = {} caught exception: {}", standbyStatus, e.getMessage(), - e); - } - } - - private void schedulePdpActivation(String pdpId, String standbyStatus) { - if (previousStandbyStatus.equals(StateManagement.PROVIDING_SERVICE)) { - // We were just here and did this successfully - logger.debug("handleStateChange: Is returning because standbyStatus is {}" - + "and was previously {}; PDP={}", standbyStatus, previousStandbyStatus, pdpId); - return; - } - - try { - // UnLock all the endpoints - logger.debug("handleStateChange: standbyStatus={}; controllers must be unlocked.", standbyStatus); - /* - * Only endpoints should be unlocked. Controllers have not been locked. Because, - * sometimes, it is possible for more than one PDP-D to become active (race - * conditions) we need to delay the activation of the topic endpoint interfaces to - * give the election algorithm time to resolve the conflict. - */ - logger.debug("handleStateChange: PROVIDING_SERVICE isWaitingForActivation= {}", - isWaitingForActivation); - - // Delay activation for 2*pdpUpdateInterval+2000 ms in case of an election handler - // conflict. - // You could have multiple election handlers thinking they can take over. - - // First let's check that the timer has not died - checkTimerStatus(); - - if (!isWaitingForActivation) { - // Just in case there is an old timer hanging around - logger.debug("handleStateChange: PROVIDING_SERVICE cancelling delayActivationTimer."); - cancelTimer(); - delayActivateTimer = timerFactory.makeTimer(); - // delay the activate so the DesignatedWaiter can run twice - delayActivateTimer.schedule(new DelayActivateClass(), waitInterval); - isWaitingForActivation = true; - startTimeWaitingForActivationMs = currentTime.getMillis(); - logger.debug("handleStateChange: PROVIDING_SERVICE scheduling delayActivationTimer in {} ms", - waitInterval); - } else { - logger.debug("handleStateChange: PROVIDING_SERVICE delayActivationTimer is " - + "waiting for activation."); - } - - } catch (Exception e) { - logger.warn("handleStateChange: PROVIDING_SERVICE standbyStatus == providingservice caught exception: ", - e); - } - } - - private void checkTimerStatus() { - if (isWaitingForActivation) { - logger.debug("handleStateChange: PROVIDING_SERVICE isWaitingForActivation = {}", - isWaitingForActivation); - long now = currentTime.getMillis(); - long waitTimeMs = now - startTimeWaitingForActivationMs; - if (waitTimeMs > 3 * waitInterval) { - logger.debug("handleStateChange: PROVIDING_SERVICE looks like the activation wait timer " - + "may be hung, waitTimeMs = {} and allowable waitInterval = {}" - + " Checking whether it is currently in activation. isNowActivating = {}", - waitTimeMs, waitInterval, isNowActivating); - // Now check that it is not currently executing an activation - if (!isNowActivating) { - logger.debug("handleStateChange: PROVIDING_SERVICE looks like the activation " - + "wait timer died"); - // This will assure the timer is cancelled and rescheduled. - isWaitingForActivation = false; - } - } - } - } - - private void standDownPdpUnsupported(String pdpId, String standbyStatus) { - if (previousStandbyStatus.equals(PmStandbyStateChangeNotifier.UNSUPPORTED)) { - // We were just here and did this successfully - logger.debug("handleStateChange: Is returning because standbyStatus is " - + "UNSUPPORTED and was previously {}; PDP={}", previousStandbyStatus, pdpId); - return; - } - - // Only want to lock the endpoints, not the controllers. - isWaitingForActivation = false; - try { - logger.debug("handleStateChange: unsupported standbystatus: cancelling delayActivationTimer."); - cancelTimer(); - getPolicyEngineManager().deactivate(); - // We know the standbystatus is unsupported - previousStandbyStatus = PmStandbyStateChangeNotifier.UNSUPPORTED; - } catch (Exception e) { - logger.warn("handleStateChange: Unsupported standbyStatus = {} " + "caught exception: {} ", - standbyStatus, e.getMessage(), e); - } - } - - private void cancelTimer() { - if (delayActivateTimer != null) { - delayActivateTimer.cancel(); - } - } - - private class DelayActivateClass extends TimerTask { - - private Object delayActivateLock = new Object(); - - - @Override - public void run() { - isNowActivating = true; - try { - logger.debug("DelayActivateClass.run: entry"); - synchronized (delayActivateLock) { - getPolicyEngineManager().activate(); - // The state change fully succeeded - previousStandbyStatus = StateManagement.PROVIDING_SERVICE; - // We want to set this to false here because the activate call can take a while - isWaitingForActivation = false; - isNowActivating = false; - } - logger.debug("DelayActivateClass.run.exit"); - } catch (Exception e) { - isWaitingForActivation = false; - isNowActivating = false; - logger.warn("DelayActivateClass.run: caught an unexpected exception " - + "calling PolicyEngineConstants.getManager().activate: ", e); - } - } - } - - // these may be overridden by junit tests - - protected PolicyEngine getPolicyEngineManager() { - return PolicyEngineConstants.getManager(); - } -} diff --git a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ThreadRunningChecker.java b/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ThreadRunningChecker.java deleted file mode 100644 index d359b5a6..00000000 --- a/feature-active-standby-management/src/main/java/org/onap/policy/drools/activestandby/ThreadRunningChecker.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * feature-active-standby-management - * ================================================================================ - * 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. - * 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.activestandby; - -@FunctionalInterface -public interface ThreadRunningChecker { - void checkThreadStatus(); - -} -- cgit 1.2.3-korg