aboutsummaryrefslogtreecommitdiffstats
path: root/integrity-audit/src/main/java/org/openecomp/policy/common/ia/AuditThread.java
blob: 2319f2114825a197d66c91e411f37230d184af04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
/*-
 * ============LICENSE_START=======================================================
 * Integrity Audit
 * ================================================================================
 * Copyright (C) 2017 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.openecomp.policy.common.ia;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.List;
import java.util.Properties;
//import org.apache.log4j.Logger;


import org.openecomp.policy.common.ia.jpa.IntegrityAuditEntity;
import org.openecomp.policy.common.logging.eelf.MessageCodes;
import org.openecomp.policy.common.logging.flexlogger.FlexLogger; 
import org.openecomp.policy.common.logging.flexlogger.Logger;

/**
 * AuditThread is the main thread for the IntegrityAudit
 * 
 */
public class AuditThread extends Thread {

	private static final Logger logger = FlexLogger.getLogger(AuditThread.class);

	/*
	 * Number of milliseconds that must elapse for audit to be considered
	 * complete. It's public for access by JUnit test logic.
	 */
	public static final long AUDIT_COMPLETION_INTERVAL = 30000;

	/*
	 * Number of iterations for audit simulation.
	 */
	public static final long AUDIT_SIMULATION_ITERATIONS = 3;

	/*
	 * Number of milliseconds to sleep between audit simulation iterations. It's
	 * public for access by JUnit test logic.
	 */
	public static final long AUDIT_SIMULATION_SLEEP_INTERVAL = 5000;

	/*
	 * Unless audit has already been run on this entity, number of milliseconds
	 * to sleep between audit thread iterations. If audit has already been run,
	 * we sleep integrityAuditPeriodMillis.
	 */
	private static final long AUDIT_THREAD_SLEEP_INTERVAL = 5000;

	/*
	 * DB access class.
	 */
	private DbDAO dbDAO;

	/*
	 * E.g. pdp_xacml
	 */
	private String nodeType;

	/*
	 * Persistence unit for which this audit is being run.
	 */
	private String persistenceUnit;

	/*
	 * Name of this resource
	 */
	private String resourceName;

	/*
	 * E.g. DB_DRIVER, SITE_NAME, NODE_TYPE
	 */
	private Properties properties;

	/*
	 * See IntegrityAudit class for usage.
	 */
	private int integrityAuditPeriodMillis;
	
	/*
	 * The containing IntegrityAudit instance
	 */
	private IntegrityAudit integrityAudit;

	/**
	 * AuditThread constructor
	 * @param resourceName
	 * @param persistenceUnit
	 * @param properties
	 * @param integrityAuditPeriodSeconds
	 * @param integrityAudit
	 * @throws Exception
	 */
	public AuditThread(String resourceName, String persistenceUnit,
			Properties properties, int integrityAuditPeriodSeconds, IntegrityAudit integrityAudit)
			throws Exception {
		this.resourceName = resourceName;
		this.persistenceUnit = persistenceUnit;
		this.properties = properties;
		this.integrityAuditPeriodMillis = integrityAuditPeriodSeconds * 1000;
		this.integrityAudit = integrityAudit;

		/*
		 * The DbDAO Constructor registers this node in the IntegrityAuditEntity
		 * table. Each resource (node) inserts its own name, persistenceUnit, DB
		 * access properties and other pertinent properties in the table. This
		 * allows the audit on each node to compare its own version of the
		 * entities for the persistenceUnit in question with the versions from
		 * all other nodes of similar type.
		 */
		dbDAO = new DbDAO(this.resourceName, this.persistenceUnit,
				this.properties);
		this.nodeType = properties.getProperty(IntegrityAuditProperties.NODE_TYPE);

	}

	public void run() {

		logger.info("AuditThread.run: Entering");

		try {
			
			/*
			 * Triggers change in designation, unless no other viable candidate.
			 */
			boolean auditCompleted = false;

			DbAudit dbAudit = new DbAudit(dbDAO);

			IntegrityAuditEntity entityCurrentlyDesignated = null;
			IntegrityAuditEntity thisEntity = null;
			integrityAudit.setThreadInitialized(true); // An exception will set
														// it to false

			while (true) {
				try{

					/*
					 * It may have been awhile since we last cycled through this
					 * loop, so refresh the list of IntegrityAuditEntities.
					 */
					List<IntegrityAuditEntity> integrityAuditEntityList = getIntegrityAuditEntityList();

					/*
					 * We could've set entityCurrentlyDesignated as a side effect of
					 * getIntegrityAuditEntityList(), but then we would've had to
					 * make entityCurrentlyDesignated a class level attribute. Using
					 * this approach, we can keep it local to the run() method.
					 */
					entityCurrentlyDesignated = getEntityCurrentlyDesignated(integrityAuditEntityList);

					/*
					 * Need to refresh thisEntity each time through loop, because we
					 * need a fresh version of lastUpdated.
					 */
					thisEntity = getThisEntity(integrityAuditEntityList);

					/*
					 * If we haven't done the audit yet, note that we're current and
					 * see if we're designated.
					 */
					if (!auditCompleted) {
						dbDAO.setLastUpdated();

						/*
						 * If no current designation or currently designated node is
						 * stale, see if we're the next node to be designated.
						 */
						if (entityCurrentlyDesignated == null
								|| isStale(entityCurrentlyDesignated)) {
							IntegrityAuditEntity designationCandidate = getDesignationCandidate(integrityAuditEntityList);

							/*
							 * If we're the next node to be designated, run the
							 * audit.
							 */
							if (designationCandidate.getResourceName().equals(
									this.resourceName)) {
								runAudit(dbAudit);
								auditCompleted = true;
							} else {
								if (logger.isDebugEnabled()) {
									logger.debug("AuditThread.run: designationCandidate, "
											+ designationCandidate
											.getResourceName()
											+ ", not this entity, "
											+ thisEntity.getResourceName());
								}
							}

							/*
							 * Application may have been stopped and restarted, in
							 * which case we might be designated but auditCompleted
							 * will have been reset to false, so account for this.
							 */
						} else if (thisEntity.getResourceName().equals(
								entityCurrentlyDesignated.getResourceName())) {

							if (logger.isDebugEnabled()) {
								logger.debug("AuditThread.run: Re-running audit for "
										+ thisEntity.getResourceName());
							}
							runAudit(dbAudit);
							auditCompleted = true;

						} else {
							if (logger.isDebugEnabled()) {
								logger.debug("AuditThread.run: Currently designated node, "
										+ entityCurrentlyDesignated
										.getResourceName()
										+ ", not yet stale and not this node");
							}
						}


						/*
						 * Audit already completed on this node, so allow the node
						 * to go stale until twice the AUDIT_COMPLETION_PERIOD has
						 * elapsed. This should give plenty of time for another node
						 * (if another node is out there) to pick up designation.
						 */
					} else {

						auditCompleted = resetAuditCompleted(auditCompleted,
								thisEntity);

					}

					/*
					 * If we've just run audit, sleep per the
					 * integrity_audit_period_seconds property, otherwise just sleep
					 * the normal interval.
					 */
					if (auditCompleted) {

						if (logger.isDebugEnabled()) {
							logger.debug("AuditThread.run: Audit completed; resourceName="
									+ this.resourceName
									+ " sleeping "
									+ integrityAuditPeriodMillis + "ms");
						}
						Thread.sleep(integrityAuditPeriodMillis);
						if (logger.isDebugEnabled()) {
							logger.debug("AuditThread.run: resourceName="
									+ this.resourceName + " awaking from "
									+ integrityAuditPeriodMillis + "ms sleep");
						}

					} else {

						if (logger.isDebugEnabled()) {
							logger.debug("AuditThread.run: resourceName="
									+ this.resourceName + ": Sleeping "
									+ AuditThread.AUDIT_THREAD_SLEEP_INTERVAL
									+ "ms");
						}
						Thread.sleep(AuditThread.AUDIT_THREAD_SLEEP_INTERVAL);
						if (logger.isDebugEnabled()) {
							logger.debug("AuditThread.run: resourceName="
									+ this.resourceName + ": Awaking from "
									+ AuditThread.AUDIT_THREAD_SLEEP_INTERVAL
									+ "ms sleep");
						}

					}
				} catch (Exception e){
					String msg = "AuditThread.run loop - Exception thrown: " + e.getMessage() 
							+ "; Will try audit again in " + (integrityAuditPeriodMillis/1000) + " seconds";
					logger.error(MessageCodes.EXCEPTION_ERROR, e, msg);
					// Sleep and try again later
					Thread.sleep(integrityAuditPeriodMillis);
					continue;
				}

			}

		} catch (Exception e) {
			String msg = "AuditThread.run: Could not start audit loop. Exception thrown; message="+ e.getMessage();
			logger.error(MessageCodes.EXCEPTION_ERROR, e, msg);
			integrityAudit.setThreadInitialized(false);
		}

		logger.info("AuditThread.run: Exiting");
	}

	/*
	 * Used to create a list that is sorted lexicographically by resourceName.
	 */
	Comparator<IntegrityAuditEntity> comparator = new Comparator<IntegrityAuditEntity>() {
		@Override
		public int compare(final IntegrityAuditEntity r1,
				final IntegrityAuditEntity r2) {
			return r1.getResourceName().compareTo(r2.getResourceName());
		}
	};

	/**
	 * getDesignationCandidate()
	 * Using round robin algorithm, gets next candidate to be designated. Assumes
	 * list is sorted lexicographically by resourceName.
	 */
	private IntegrityAuditEntity getDesignationCandidate(
			List<IntegrityAuditEntity> integrityAuditEntityList) {
		
		//Note: assumes integrityAuditEntityList is already lexicographically sorted by resourceName

		if (logger.isDebugEnabled()) {
			logger.debug("getDesignationCandidate: Entering, integrityAuditEntityList.size()="
					+ integrityAuditEntityList.size());
		}

		IntegrityAuditEntity designationCandidate = null;
		IntegrityAuditEntity thisEntity = null;

		int designatedEntityIndex = -1;
		int entityIndex = 0;
		int priorCandidateIndex = -1;
		int subsequentCandidateIndex = -1;

		for (IntegrityAuditEntity integrityAuditEntity : integrityAuditEntityList) {

			if (logger.isDebugEnabled()) {
				logIntegrityAuditEntity(integrityAuditEntity);
			}

			if (integrityAuditEntity.getResourceName()
					.equals(this.resourceName)) {
				if (logger.isDebugEnabled()) {
					logger.debug("getDesignationCandidate: thisEntity="
							+ integrityAuditEntity.getResourceName());
				}
				thisEntity = integrityAuditEntity;
			}

			if (integrityAuditEntity.isDesignated()) {
				if (logger.isDebugEnabled()) {
					logger.debug("getDesignationCandidate: Currently designated entity resourceName="
							+ integrityAuditEntity.getResourceName()
							+ ", persistenceUnit="
							+ integrityAuditEntity.getPersistenceUnit()
							+ ", lastUpdated="
							+ integrityAuditEntity.getLastUpdated()
							+ ", entityIndex=" + entityIndex);
				}
				designatedEntityIndex = entityIndex;

				/*
				 * Entity not currently designated
				 */
			} else {

				/*
				 * See if non-designated entity is stale.
				 */
				if (isStale(integrityAuditEntity)) {

					if (logger.isDebugEnabled()) {
						logger.debug("getDesignationCandidate: Entity is stale; resourceName="
								+ integrityAuditEntity.getResourceName()
								+ ", persistenceUnit="
								+ integrityAuditEntity.getPersistenceUnit()
								+ ", lastUpdated="
								+ integrityAuditEntity.getLastUpdated()
								+ ", entityIndex=" + entityIndex);
					}

					/*
					 * Entity is current.
					 */
				} else {

					if (designatedEntityIndex == -1) {

						if (priorCandidateIndex == -1) {
							if (logger.isDebugEnabled()) {
								logger.debug("getDesignationCandidate: Prior candidate found, resourceName="
										+ integrityAuditEntity
												.getResourceName()
										+ ", persistenceUnit="
										+ integrityAuditEntity
												.getPersistenceUnit()
										+ ", lastUpdated="
										+ integrityAuditEntity.getLastUpdated()
										+ ", entityIndex=" + entityIndex);
							}
							priorCandidateIndex = entityIndex;
						} else {
							if (logger.isDebugEnabled()) {
								logger.debug("getDesignationCandidate: Prior entity current but prior candidate already found; resourceName="
										+ integrityAuditEntity
												.getResourceName()
										+ ", persistenceUnit="
										+ integrityAuditEntity
												.getPersistenceUnit()
										+ ", lastUpdated="
										+ integrityAuditEntity.getLastUpdated()
										+ ", entityIndex=" + entityIndex);
							}
						}
					} else {
						if (subsequentCandidateIndex == -1) {
							if (logger.isDebugEnabled()) {
								logger.debug("getDesignationCandidate: Subsequent candidate found, resourceName="
										+ integrityAuditEntity
												.getResourceName()
										+ ", persistenceUnit="
										+ integrityAuditEntity
												.getPersistenceUnit()
										+ ", lastUpdated="
										+ integrityAuditEntity.getLastUpdated()
										+ ", entityIndex=" + entityIndex);
							}
							subsequentCandidateIndex = entityIndex;
						} else {
							if (logger.isDebugEnabled()) {
								logger.debug("getDesignationCandidate: Subsequent entity current but subsequent candidate already found; resourceName="
										+ integrityAuditEntity
												.getResourceName()
										+ ", persistenceUnit="
										+ integrityAuditEntity
												.getPersistenceUnit()
										+ ", lastUpdated="
										+ integrityAuditEntity.getLastUpdated()
										+ ", entityIndex=" + entityIndex);
							}
						}
					}

				} // end entity is current

			} // end entity not currently designated

			entityIndex++;

		} // end for loop

		/*
		 * Per round robin algorithm, if a current entity is found that is
		 * lexicographically after the currently designated entity, this entity
		 * becomes the designation candidate. If no current entity is found that
		 * is lexicographically after currently designated entity, we cycle back
		 * to beginning of list and pick the first current entity as the
		 * designation candidate.
		 */
		if (subsequentCandidateIndex != -1) {
			designationCandidate = integrityAuditEntityList
					.get(subsequentCandidateIndex);
			if (logger.isDebugEnabled()) {
				logger.debug("getDesignationCandidate: Exiting and returning subsequent designationCandidate="
						+ designationCandidate.getResourceName());
			}
		} else {
			if (priorCandidateIndex != -1) {
				designationCandidate = integrityAuditEntityList
						.get(priorCandidateIndex);
				if (logger.isDebugEnabled()) {
					logger.debug("getDesignationCandidate: Exiting and returning prior designationCandidate="
							+ designationCandidate.getResourceName());
				}
			} else {
				logger.debug("getDesignationCandidate: No subsequent or prior candidate found; designating thisEntity, resourceName="
						+ thisEntity.getResourceName());
				designationCandidate = thisEntity;
			}
		}

		return designationCandidate;

	}

	/**
	 * getEntityCurrentlyDesignated()
	 * Returns entity that is currently designated.
	 * @param integrityAuditEntityList
	 * @return
	 */
	private IntegrityAuditEntity getEntityCurrentlyDesignated(
			List<IntegrityAuditEntity> integrityAuditEntityList) {

		if (logger.isDebugEnabled()) {
			logger.debug("getEntityCurrentlyDesignated: Entering, integrityAuditEntityList.size="
					+ integrityAuditEntityList.size());
		}

		IntegrityAuditEntity entityCurrentlyDesignated = null;

		for (IntegrityAuditEntity integrityAuditEntity : integrityAuditEntityList) {

			if (integrityAuditEntity.isDesignated()) {
				if (logger.isDebugEnabled()) {
					logger.debug("getEntityCurrentlyDesignated: Currently designated entity resourceName="
							+ integrityAuditEntity.getResourceName()
							+ ", persistenceUnit="
							+ integrityAuditEntity.getPersistenceUnit()
							+ ", lastUpdated="
							+ integrityAuditEntity.getLastUpdated());
				}
				entityCurrentlyDesignated = integrityAuditEntity;
			}

		} // end for loop

		if (logger.isDebugEnabled()) {
			if (entityCurrentlyDesignated != null) {
				logger.debug("getEntityCurrentlyDesignated: Exiting and returning entityCurrentlyDesignated="
						+ entityCurrentlyDesignated.getResourceName());
			} else {
				logger.debug("getEntityCurrentlyDesignated: Exiting and returning entityCurrentlyDesignated="
						+ entityCurrentlyDesignated);
			}
		}
		return entityCurrentlyDesignated;

	}

	/**
	 * getIntegrityAuditEnityList gets the list of IntegrityAuditEntity 
	 * @return
	 * @throws DbDaoTransactionException
	 */
	private List<IntegrityAuditEntity> getIntegrityAuditEntityList()
			throws DbDaoTransactionException {

		if (logger.isDebugEnabled()) {
			logger.debug("getIntegrityAuditEntityList: Entering");
		}

		/*
		 * Get all records for this nodeType and persistenceUnit and then sort
		 * them lexicographically by resourceName. Get index of designated
		 * entity, if any.
		 */
		/*
		 * Sorted list of entities for a particular nodeType and
		 * persistenceUnit.
		 */
		List<IntegrityAuditEntity> integrityAuditEntityList = new ArrayList<IntegrityAuditEntity>();
		integrityAuditEntityList = dbDAO.getIntegrityAuditEntities(
				this.persistenceUnit, this.nodeType);
		int listSize = integrityAuditEntityList.size();
		if (logger.isDebugEnabled()) {
			logger.debug("getIntegrityAuditEntityList: Got " + listSize
					+ " IntegrityAuditEntity records");
		}
		Collections.sort((List<IntegrityAuditEntity>) integrityAuditEntityList,
				comparator);

		if (logger.isDebugEnabled()) {
			logger.debug("getIntegrityAuditEntityList: Exiting and returning integrityAuditEntityList, size="
					+ listSize);
		}
		return integrityAuditEntityList;

	}


	/**
	 * Returns the IntegrityAuditEntity for this entity.
	 * @param integrityAuditEntityList
	 * @return
	 */
	private IntegrityAuditEntity getThisEntity(
			List<IntegrityAuditEntity> integrityAuditEntityList) {

		if (logger.isDebugEnabled()) {
			logger.debug("getThisEntity: Entering, integrityAuditEntityList.size="
					+ integrityAuditEntityList.size());
		}

		IntegrityAuditEntity thisEntity = null;

		for (IntegrityAuditEntity integrityAuditEntity : integrityAuditEntityList) {

			if (integrityAuditEntity.getResourceName().equals(this.resourceName)) {
				if (logger.isDebugEnabled()) {
					logger.debug("getThisEntity: For this entity, resourceName="
							+ integrityAuditEntity.getResourceName()
							+ ", persistenceUnit="
							+ integrityAuditEntity.getPersistenceUnit()
							+ ", lastUpdated="
							+ integrityAuditEntity.getLastUpdated());
				}
				thisEntity = integrityAuditEntity;
			}

		} // end for loop

		if (logger.isDebugEnabled()) {
			if (thisEntity != null) {
				logger.debug("getThisEntity: Exiting and returning thisEntity="
						+ thisEntity.getResourceName());
			} else {
				logger.debug("getThisEntity: Exiting and returning thisEntity="
						+ thisEntity);
			}
		}
		return thisEntity;

	}


	/**
	 * Returns false if the lastUpdated time for the record in question is more
	 * than AUDIT_COMPLETION_INTERVAL seconds ago. During an audit, lastUpdated is updated every five
	 * seconds or so, but when an audit finishes, the node doing the audit stops
	 * updating lastUpdated.
	 * @param integrityAuditEntity
	 * @return
	 */
	private boolean isStale(IntegrityAuditEntity integrityAuditEntity) {

		if (logger.isDebugEnabled()) {
			logger.debug("isStale: Entering, resourceName="
					+ integrityAuditEntity.getResourceName()
					+ ", persistenceUnit="
					+ integrityAuditEntity.getPersistenceUnit()
					+ ", lastUpdated=" + integrityAuditEntity.getLastUpdated());
		}

		boolean stale = false;

		Date currentTime = new Date();
		Date lastUpdated = integrityAuditEntity.getLastUpdated();

		/*
		 * If lastUpdated is null, we assume that the audit never ran for that
		 * node.
		 */
		long lastUpdatedTime = 0;
		if (lastUpdated != null) {
			lastUpdatedTime = lastUpdated.getTime();
		}
		long timeDifference = currentTime.getTime() - lastUpdatedTime;
		if (timeDifference > AUDIT_COMPLETION_INTERVAL) {
			stale = true;
		}

		if (logger.isDebugEnabled()) {
			logger.debug("isStale: Exiting and returning stale=" + stale
					+ ", timeDifference=" + timeDifference);
		}

		return stale;
	}

	private void logIntegrityAuditEntity(
			IntegrityAuditEntity integrityAuditEntity) {

		logger.debug("logIntegrityAuditEntity: id="
				+ integrityAuditEntity.getId() + ", jdbcDriver="
				+ integrityAuditEntity.getJdbcDriver() + ", jdbcPassword="
				+ integrityAuditEntity.getJdbcPassword() + ", jdbcUrl="
				+ integrityAuditEntity.getJdbcUrl() + ", jdbcUser="
				+ integrityAuditEntity.getJdbcUser() + ", nodeType="
				+ integrityAuditEntity.getNodeType() + ", persistenceUnit="
				+ integrityAuditEntity.getPersistenceUnit() + ", resourceName="
				+ integrityAuditEntity.getResourceName() + ", site="
				+ integrityAuditEntity.getSite() + ", createdDate="
				+ integrityAuditEntity.getCreatedDate() + ", lastUpdated="
				+ integrityAuditEntity.getLastUpdated() + ", designated="
				+ integrityAuditEntity.isDesignated());
	}
	
	/*
	 * If more than (AUDIT_COMPLETION_INTERVAL * 2) milliseconds have elapsed
	 * since we last ran the audit, reset auditCompleted, so
	 * 
	 * 1) we'll eventually re-run the audit, if no other node picks up the
	 * designation.
	 * 
	 * or
	 * 
	 * 2) We'll run the audit when the round robin comes back to us.
	 */
	private boolean resetAuditCompleted(boolean auditCompleted,
			IntegrityAuditEntity thisEntity) {

		if (logger.isDebugEnabled()) {
			logger.debug("resetAuditCompleted: auditCompleted="
					+ auditCompleted + "; for thisEntity, resourceName="
					+ thisEntity.getResourceName() + ", persistenceUnit="
					+ thisEntity.getPersistenceUnit() + ", lastUpdated="
					+ thisEntity.getLastUpdated());
		}

		long timeDifference = -1;

		Date currentTime = new Date();
		Date lastUpdated = thisEntity.getLastUpdated();

		long lastUpdatedTime = lastUpdated.getTime();
		timeDifference = currentTime.getTime() - lastUpdatedTime;

		if (timeDifference > (AUDIT_COMPLETION_INTERVAL * 2)) {
			if (logger.isDebugEnabled()) {
				logger.debug("resetAuditCompleted: Resetting auditCompleted for resourceName="
						+ this.resourceName);
			}
			auditCompleted = false;
		} else {
			if (logger.isDebugEnabled()) {
				logger.debug("resetAuditCompleted: For resourceName="
						+ resourceName
						+ ", time since last update is only "
						+ timeDifference + "; retaining current value for auditCompleted");
			}
		}

		if (logger.isDebugEnabled()) {
			logger.debug("resetAuditCompleted: Exiting and returning auditCompleted="
					+ auditCompleted + ", timeDifference=" + timeDifference);
		}
		return auditCompleted;
	}

	private void runAudit(DbAudit dbAudit) throws Exception {

		if (logger.isDebugEnabled()) {
			logger.debug("runAudit: Entering, dbAudit=" + dbAudit
					+ "; notifying other resources that resourceName="
					+ this.resourceName + " is current");
		}

		/*
		 * changeDesignated marks all other nodes as non-designated and this
		 * node as designated.
		 */
		dbDAO.changeDesignated(this.resourceName, this.persistenceUnit,
				this.nodeType);

		if (logger.isDebugEnabled()) {
			logger.debug("runAudit: Running audit for persistenceUnit="
					+ this.persistenceUnit + " on resourceName="
					+ this.resourceName);
		}
		if (IntegrityAudit.isUnitTesting) {
			dbAudit.dbAuditSimulate(this.resourceName, this.persistenceUnit,
					this.nodeType);
		} else {
			dbAudit.dbAudit(this.resourceName, this.persistenceUnit,
					this.nodeType);
		}

		if (logger.isDebugEnabled()) {
			logger.debug("runAudit: Exiting");
		}

	}

}