Merge pull request #12 from Nuix/9.2_refactor

9.2 refactor

Author: JuicyDragon

Java/src/main/java/com/nuix/javaenginesimple/EngineWrapper.java

@@ -3,9 +3,15 @@
 import java.io.File;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
 import java.util.function.Consumer;
+import java.util.stream.Stream;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.core.appender.ConsoleAppender;
+import org.apache.logging.log4j.core.layout.PatternLayout;
 
 import nuix.Utilities;
 import nuix.engine.AvailableLicence;
@@ -27,29 +33,47 @@
  *
  */
 public class EngineWrapper implements AutoCloseable {
-	// Obtain a logger instance for this class
-	private final static Logger logger = Logger.getLogger("EngineWrapper");
-	
 	private static GlobalContainer container = null;
+	private static boolean loggingInitHasBeenPerformed = false;
 
 	private File nuixBaseDirectory = null;
 	private Engine engine = null;
-	
 	private Thread shutdownHook = null;
-	
-	// We will use this while iterating licenses to determine which one to acquire.
-	// By default this filter accepts any license.
-	private LicenseFilter licenseFilter = new LicenseFilter();
-	
+	private LicenseFilter licenseFilter = null;
 	private CertificateTrustCallback certificateTrustCallback = null;
 
+	public Logger logger = null;
+	
 	/***
 	 * Creates a new instance running against the specified engine release.
 	 * @param nuixBaseDirectory Base directory of the target engine release.
+	 * @param logDirectory Where logs for this sessions should be written to
 	 */
-	public EngineWrapper(File nuixBaseDirectory){
+	public EngineWrapper(File nuixBaseDirectory, String logDirectory){
 		this.nuixBaseDirectory = nuixBaseDirectory;
 
+		// Lets only initialize the logging stuff the first time
+		if(!loggingInitHasBeenPerformed) {
+			System.getProperties().put("nuix.logdir", logDirectory);
+			
+			// Use Log4j2 config YAML from engine base directory
+			File log4jConfigFile = new File(nuixBaseDirectory,"config/log4j2.yml");
+			System.setProperty("log4j.configurationFile",log4jConfigFile.getAbsolutePath());
+			logger = LogManager.getLogger("EngineWrapper");
+			
+			// Register our own console appender that writes more than just fatal errors
+			PatternLayout layout = PatternLayout.newBuilder().withPattern("%d{yyyy-MM-dd HH:mm:ss.SSS Z} [%t] %r %-5p %c - %m%n").build();
+		    ConsoleAppender appender = ConsoleAppender.createDefaultAppenderForLayout(layout);
+		    appender.start();
+		    LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
+		    ctx.getRootLogger().addAppender(appender);
+		    ctx.updateLoggers();
+		    
+		    loggingInitHasBeenPerformed = true;
+		}
+	    
+		licenseFilter = new LicenseFilter();
+		
 		// We want to set the System property "nuix.libdir" so that when the engine spins up worker processes,
 		// that it can specify the "lib" directory properly to the workers.  Without this the engine will instead
 		// attempt to specify an absolute path to each of the JARs, which can cause the command used to start the
@@ -71,9 +95,10 @@ public EngineWrapper(File nuixBaseDirectory){
 	/***
 	 * Creates a new instance running against the specified engine release.
 	 * @param nuixBaseDirectory Base directory of the target engine release.
+	 * @param logDirectory Where logs for this sessions should be written to
 	 */
-	public EngineWrapper(String nuixBaseDirectory){
-		this(new File(nuixBaseDirectory));
+	public EngineWrapper(String nuixBaseDirectory, String logDirectory){
+		this(new File(nuixBaseDirectory), logDirectory);
 	}
 
 	/***
@@ -113,10 +138,6 @@ public void withDongleLicense(Consumer<Utilities> consumer) throws Exception{
 						Utilities utilities = engine.getUtilities();
 						ThirdPartyDependencyChecker.logAllDependencyInfo(utilities);
 
-						// Setup our shutdown hook in case user terminates before consumer returns
-						logger.info("Adding shutdown hook for EngineWrapper::close");
-						Runtime.getRuntime().addShutdownHook(shutdownHook);
-						
 						logger.info("License was obtained, providing Utilities object to consumer...");
 						consumer.accept(utilities);
 					}
@@ -201,7 +222,7 @@ public void withServerLicense(final String server, final String userName, final
 
 				logger.info("Specifying credentials to use with license server...");
 				engine.whenAskedForCredentials(new CredentialsCallback() {
-					Logger logger = Logger.getLogger("CredentialCallback");
+					Logger logger = LogManager.getLogger("CredentialCallback");
 					public void execute(CredentialsCallbackInfo info) {
 						logger.info(String.format("Providing credentials for %s to license server %s...", userName,info.getAddress().getHostName()));
 						info.setUsername(userName);
@@ -222,11 +243,7 @@ public void execute(CredentialsCallbackInfo info) {
 					if(licenseObtained){
 						Utilities utilities = engine.getUtilities();
 						ThirdPartyDependencyChecker.logAllDependencyInfo(utilities);
-						
-						// Setup our shutdown hook in case user terminates before consumer returns
-						logger.info("Adding shutdown hook for EngineWrapper::close");
-						Runtime.getRuntime().addShutdownHook(shutdownHook);
-						
+												
 						logger.info("License was obtained, providing Utilities object to consumer...");
 						consumer.accept(utilities);
 					} else {
@@ -296,7 +313,7 @@ public void withCloudLicense(final String userName, final String password, Consu
 
 				logger.info("Specifying credentials to use with cloud license server...");
 				engine.whenAskedForCredentials(new CredentialsCallback() {
-					Logger logger = Logger.getLogger("CredentialCallback");
+					Logger logger = LogManager.getLogger("CredentialCallback");
 					public void execute(CredentialsCallbackInfo info) {
 						logger.info(String.format("Providing credentials for %s to cloud license server %s...", userName,info.getAddress().getHostName()));
 						info.setUsername(userName);
@@ -317,10 +334,6 @@ public void execute(CredentialsCallbackInfo info) {
 					if(licenseObtained){
 						Utilities utilities = engine.getUtilities();
 						ThirdPartyDependencyChecker.logAllDependencyInfo(utilities);
-
-						// Setup our shutdown hook in case user terminates before consumer returns
-						logger.info("Adding shutdown hook for EngineWrapper::close");
-						Runtime.getRuntime().addShutdownHook(shutdownHook);
 
 						logger.info("License was obtained, providing Utilities object to consumer...");
 						consumer.accept(utilities);
@@ -362,45 +375,25 @@ private boolean obtainLicense(Map<String,Object> licenseOptions){
 			logger.info(String.format("\t%s: %s",entry.getKey(),entry.getValue()));
 		}
 
-		Iterable<AvailableLicence> licences = licensor.findAvailableLicences(licenseOptions);
-		
-		logger.info("Iterating available licences...");
-		for(AvailableLicence license : licences) {
-			logger.info(LicenseFeaturesLogger.summarizeLicense(license));
-		}
-		
-		boolean licenceObtained = false;
-		
 		logger.info("Finding first license which meets filter requirements...");
-		for(AvailableLicence license : licences) {
-			logger.info("\t Count: " + license.getCount());
-			logger.info("\t Workers: " + license.getWorkers());
-			logger.info("\t Short Name: " + license.getShortName());
-			logger.info("\t Type: " + license.getSource().getType());
-			logger.info("\t ID: " + license.getSource().getLocation());
-			logger.info("\t Description: " + license.getDescription());
-			LicenseFeaturesLogger.logFeaturesOfLicense(license);
-			
-			if(licenseFilter.isValid(license)) {
-				if(license.canChooseWorkers()) {
-					logger.info(">>>> Acquiring this licence with "+licenseFilter.getMinWorkers()+" workers");
-					int targetWorkerCount = licenseFilter.getMinWorkers();
-					if(targetWorkerCount < 1) { targetWorkerCount = 2; }
-					Map<String,Object> acquireSettings = new HashMap<String,Object>();
-					acquireSettings.put("workerCount", targetWorkerCount);
-					license.acquire(acquireSettings);
-					licenceObtained = true;	
-				} else {
-					logger.info(">>>> Acquiring this licence");
-					license.acquire();
-					licenceObtained = true;	
-				}
-				
-				break;
+		Stream<AvailableLicence> licences = licensor.findAvailableLicencesStream(licenseOptions);
+		boolean licenceObtained = false;
+		Optional<AvailableLicence> possiblyFoundLicense = licences.filter(availableLicence -> licenseFilter.isValid(availableLicence)).findFirst();
+		if(possiblyFoundLicense.isEmpty() == false) {
+			AvailableLicence foundLicense = possiblyFoundLicense.get();
+			logger.info(">>>> Acquiring following license: "+LicenseFeaturesLogger.summarizeLicense(foundLicense));
+			if(foundLicense.canChooseWorkers()) {
+				int targetWorkerCount = licenseFilter.getMinWorkers();
+				if(targetWorkerCount < 1) { targetWorkerCount = 2; }
+				Map<String,Object> acquireSettings = new HashMap<String,Object>();
+				acquireSettings.put("workerCount", targetWorkerCount);
+				foundLicense.acquire(acquireSettings);
 			} else {
-				logger.info("<<<< Ignoring this license, does not meet requirements of license filter");
-				continue;
+				foundLicense.acquire();
 			}
+			licenceObtained = true;
+		} else {
+			logger.warn("!!!! No license found that matches "+licenseFilter.toString());
 		}
 
 		return licenceObtained;
@@ -426,8 +419,11 @@ private void configureAndBuildEngine(){
 
 		//Obtain an engine instance
 		engine = container.newEngine(engineConfiguration);
-		
 		logger.info("Obtained Engine instance v"+engine.getVersion());
+		
+		// Setup our shutdown hook in case user terminates before consumer returns
+		logger.info("Adding shutdown hook for EngineWrapper::close");
+		Runtime.getRuntime().addShutdownHook(shutdownHook);
 	}
 
 	/***
@@ -524,8 +520,11 @@ public void close() throws Exception {
 			engine.close();
 		}
 
-		// Remove our shutdown hook since engine has now been closed
-		logger.info("Removing shutdown hook to EngineWrapper::close");
-		Runtime.getRuntime().removeShutdownHook(shutdownHook);
+		if(shutdownHook != null) {
+			// Remove our shutdown hook since engine has now been closed
+			logger.info("Removing shutdown hook to EngineWrapper::close");
+			Runtime.getRuntime().removeShutdownHook(shutdownHook);
+			shutdownHook = null;
+		}
 	}
 }

Java/src/main/java/com/nuix/javaenginesimple/LicenseFeaturesLogger.java

@@ -4,7 +4,8 @@
 import java.util.ArrayList;
 import java.util.StringJoiner;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import nuix.LicenceProperties;
 import nuix.engine.AvailableLicence;
@@ -16,7 +17,7 @@
  */
 public class LicenseFeaturesLogger {
 	// Obtain a logger instance for this class
-	private final static Logger logger = Logger.getLogger("LicenseFeatures");
+	private final static Logger logger = LogManager.getLogger("LicenseFeatures");
 
 	// List of license features
 	// List generated from 7.6 license profiles documentation found here:

Java/src/main/java/com/nuix/javaenginesimple/LicenseFilter.java

@@ -3,7 +3,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import nuix.engine.AvailableLicence;
 
@@ -15,7 +16,7 @@
  */
 public class LicenseFilter {
 	// Obtain a logger instance for this class
-	private final static Logger logger = Logger.getLogger("LicenseFilter");
+	private final static Logger logger = LogManager.getLogger("LicenseFilter");
 
 	private int minWorkers = 0;
 	private int maxWorkers = 0;
@@ -176,4 +177,10 @@ public void clearRequiredFeatures() {
 		}
 		requiredFeatures.clear();
 	}
+
+	@Override
+	public String toString() {
+		return "LicenseFilter [minWorkers=" + minWorkers + ", maxWorkers=" + maxWorkers + ", name=" + name
+				+ ", requiredFeatures=" + requiredFeatures + "]";
+	}
 }

Java/src/main/java/com/nuix/javaenginesimple/NuixDiagnostics.java

@@ -10,25 +10,24 @@
 import javax.management.MBeanServerFactory;
 import javax.management.ObjectName;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
 import org.joda.time.DateTime;
 
 public class NuixDiagnostics {
 	// Obtain a logger instance for this class
-	private final static Logger logger = Logger.getLogger(NuixDiagnostics.class);
+	private final static Logger logger = LogManager.getLogger(NuixDiagnostics.class);
 
-	public static void saveDiagnostics(File directory){
+	public static void saveDiagnosticsToFile(File zipFile){
 		List<MBeanServer> beanServers = new ArrayList<MBeanServer>();
 		beanServers.add(ManagementFactory.getPlatformMBeanServer());
 		beanServers.addAll(MBeanServerFactory.findMBeanServer(null));
 		for (MBeanServer mBeanServer : beanServers) {
 			Set<ObjectName> objectNames = mBeanServer.queryNames(null, null);
 			for (ObjectName beanName : objectNames) {
 				if(beanName.toString().contains("DiagnosticsControl")){
-					directory.mkdirs();
-					DateTime timeStamp = DateTime.now();
-					String timeStampString = timeStamp.toString("yyyyMMddHHmmss");
-					File zipFile = new File(directory,"NuixEngineDiagnostics-"+timeStampString+".zip");
+					zipFile.mkdirs();
+					
 					try {
 						mBeanServer.invoke(beanName,"generateDiagnostics",new Object[] {zipFile.getPath()},new String[] {"java.lang.String"});
 						return;
@@ -40,5 +39,16 @@ public static void saveDiagnostics(File directory){
 		}
 	}
 
-	public static void saveDiagnostics(String directory) { saveDiagnostics(new File(directory)); }
+	public static void saveDiagnosticsToFile(String zipFile) { saveDiagnosticsToFile(new File(zipFile)); }
+	
+	public static void saveDiagnosticsToDirectory(File directory) {
+		DateTime timeStamp = DateTime.now();
+		String timeStampString = timeStamp.toString("yyyyMMddHHmmss");
+		File zipFile = new File(directory,"NuixEngineDiagnostics-"+timeStampString+".zip");
+		saveDiagnosticsToFile(zipFile);
+	}
+	
+	public static void saveDiagnosticsToDirectory(String directory) {
+		saveDiagnosticsToDirectory(new File(directory));
+	}
 }

Java/src/main/java/com/nuix/javaenginesimple/NuixVersion.java

@@ -3,18 +3,7 @@
 import java.util.regex.Pattern;
 
 /***
- * Assists in representing a Nuix version in object form to assist with comparing two versions.  This allows for things such as
- * only executing chunks of code if the version meets a requirement.<br>
- * Ruby example:
- * <pre>
- * {@code
- * current_version = NuixVersion.new(NUIX_VERSION)
- * if current_version.isLessThan("7.8.0.10")
- *     puts "Sorry your version of Nuix is below the minimum required version of 7.8.0.10"
- *     exit 1
- * end
- * }
- * </pre>
+ * Provides a wrapper around Nuix version string that allows for comparison of versions.
  * @author Jason Wells
  *
  */

Java/src/main/java/com/nuix/javaenginesimple/ThirdPartyDependencyChecker.java

@@ -2,7 +2,8 @@
 
 import java.util.List;
 
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import nuix.ThirdPartyDependency;
 import nuix.ThirdPartyDependencyStatus;
@@ -15,7 +16,7 @@
  */
 public class ThirdPartyDependencyChecker {
 	// Obtain a logger instance for this class
-	private final static Logger logger = Logger.getLogger("ThirdPartyDependencyChecker");
+	private final static Logger logger = LogManager.getLogger("ThirdPartyDependencyChecker");
 
 	/***
 	 * Logs information about all Nuix third party dependencies