Merge pull request #496 from raman-bt/develop

Defined IngestModuleException that an ingest module may throw if init() fails.

Core/src/org/sleuthkit/autopsy/examples/SampleDataSourceIngestModule.java

@@ -89,7 +89,7 @@ import org.sleuthkit.datamodel.TskCoreException;
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         // do nothing
     }
 

Core/src/org/sleuthkit/autopsy/examples/SampleFileIngestModule.java

@@ -72,7 +72,7 @@ import org.sleuthkit.datamodel.TskData;
 
     
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         /* For this demo, we are going to make a private attribute to post our
          * results to the blackbaord with. There are many standard blackboard artifact
          * and attribute types and you should first consider using one of those before

Core/src/org/sleuthkit/autopsy/ingest/IngestDataSourceThread.java

@@ -31,6 +31,7 @@ import org.openide.util.Cancellable;
 import org.sleuthkit.autopsy.coreutils.PlatformUtil;
 import org.sleuthkit.autopsy.coreutils.StopWatch;
 import org.sleuthkit.autopsy.ingest.IngestManager.IngestModuleEvent;
+import org.sleuthkit.autopsy.ingest.IngestModuleAbstract.IngestModuleException;
 import org.sleuthkit.datamodel.Content;
 
 /**
@@ -75,13 +76,13 @@ import org.sleuthkit.datamodel.Content;
         return module;
     }
     
-    public void init() {
+    public void init() throws IngestModuleException{
         
         logger.log(Level.INFO, "Initializing module: " + module.getName());
         try {
             module.init(init);
             inited = true;
-        } catch (Exception e) {
+        } catch (IngestModuleException e) {
             logger.log(Level.INFO, "Failed initializing module: " + module.getName() + ", will not run.");
             //will not run
             inited = false;

Core/src/org/sleuthkit/autopsy/ingest/IngestManager.java

@@ -42,6 +42,7 @@ import org.sleuthkit.autopsy.coreutils.PlatformUtil;
 import org.sleuthkit.autopsy.coreutils.StopWatch;
 import org.sleuthkit.autopsy.ingest.IngestMessage.MessageType;
 import org.sleuthkit.autopsy.ingest.IngestScheduler.FileScheduler.FileTask;
+import org.sleuthkit.autopsy.ingest.IngestModuleAbstract.IngestModuleException;
 import org.sleuthkit.datamodel.AbstractFile;
 import org.sleuthkit.datamodel.Content;
 
@@ -459,7 +460,7 @@ public class IngestManager {
                 IngestModuleInit moduleInit = new IngestModuleInit();
                 try {
                     s.init(moduleInit);
-                } catch (Exception e) {
+                } catch (IngestModuleException e) {
                     logger.log(Level.SEVERE, "File ingest module failed init(): " + s.getName(), e);
                     allInited = false;
                     failedModule = s;

Core/src/org/sleuthkit/autopsy/ingest/IngestModuleAbstract.java

@@ -23,7 +23,7 @@ package org.sleuthkit.autopsy.ingest;
 /**
  * Base interface for ingest modules
  */
- abstract class IngestModuleAbstract {
+ public abstract class IngestModuleAbstract {
     
     private String args;
     
@@ -42,6 +42,13 @@ package org.sleuthkit.autopsy.ingest;
         AbstractFile
     };
     
+    public class IngestModuleException extends Exception {
+        IngestModuleException(String msg) {
+            super(msg);
+        }
+    }
+    
+
     /**
      * Invoked every time an ingest session is started by the framework.  
      * A module should support multiple invocations of init() throughout the application life-cycle.  
@@ -55,8 +62,10 @@ package org.sleuthkit.autopsy.ingest;
      * NEVER initialize IngestServices handle in the member declaration, because it might result
      * in multiple instances of the singleton -- different class loaders are used in different modules.
      * @param initContext context used to initialize some modules
+     * 
+     * @throws IngestModuleException if a critical error occurs in initializing the module.
      */
-    abstract public void init(IngestModuleInit initContext);
+    abstract public void init(IngestModuleInit initContext) throws IngestModuleException;
 
     /**
      * Invoked when an ingest session completes.  

ExifParser/src/org/sleuthkit/autopsy/exifparser/ExifParserFileIngestModule.java

@@ -226,7 +226,7 @@ public final class ExifParserFileIngestModule extends IngestModuleAbstractFile {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
         logger.log(Level.INFO, "init() " + this.toString());
 

FileExtMismatch/src/org/sleuthkit/autopsy/fileextmismatch/FileExtMismatchIngestModule.java

@@ -83,7 +83,7 @@ public class FileExtMismatchIngestModule extends org.sleuthkit.autopsy.ingest.In
 
     
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();           
         
         // Load mapping

FileTypeId/src/org/sleuthkit/autopsy/filetypeid/FileTypeIdIngestModule.java

@@ -76,7 +76,7 @@ import org.sleuthkit.datamodel.TskException;
 
     
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
     }
     

HashDatabase/src/org/sleuthkit/autopsy/hashdatabase/HashDbIngestModule.java

@@ -45,6 +45,7 @@ import org.sleuthkit.datamodel.TskCoreException;
 import org.sleuthkit.datamodel.TskData;
 import org.sleuthkit.datamodel.TskException;
 import org.sleuthkit.autopsy.hashdatabase.HashDbManager.HashDb;
+import org.sleuthkit.autopsy.ingest.IngestModuleAbstract.IngestModuleException;
 import org.sleuthkit.datamodel.HashInfo;
 
 public class HashDbIngestModule extends IngestModuleAbstractFile {
@@ -145,7 +146,7 @@ public class HashDbIngestModule extends IngestModuleAbstractFile {
     }
     
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
         skCase = Case.getCurrentCase().getSleuthkitCase();
 

KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java

@@ -343,7 +343,7 @@ public final class KeywordSearchIngestModule extends IngestModuleAbstractFile {
      *
      */
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         logger.log(Level.INFO, "init()");
         services = IngestServices.getDefault();
         initialized = false;

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/Chrome.java

@@ -502,7 +502,7 @@ class Chrome extends Extract {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
     }
 

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/ExtractIE.java

@@ -480,7 +480,7 @@ class ExtractIE extends Extract {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
     }
 

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/ExtractRegistry.java

@@ -540,7 +540,7 @@ class ExtractRegistry extends Extract {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
     }
 
     @Override

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/Firefox.java

@@ -479,7 +479,7 @@ class Firefox extends Extract {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
     }
 

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/RAImageIngestModule.java

@@ -150,7 +150,7 @@ public final class RAImageIngestModule extends IngestModuleDataSource {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         modules = new ArrayList<>();
         browserModules = new ArrayList();
         logger.log(Level.INFO, "init() {0}", this.toString());
@@ -180,7 +180,7 @@ public final class RAImageIngestModule extends IngestModuleDataSource {
         for (Extract module : modules) {
             try {
                 module.init(initContext);
-            } catch (Exception ex) {
+            } catch (IngestModuleException ex) {
                 logger.log(Level.SEVERE, "Exception during init() of " + module.getName(), ex);
             }
         }

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/RecentDocumentsByLnk.java

@@ -121,7 +121,7 @@ class RecentDocumentsByLnk extends Extract  {
     }
    
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
     }
 

RecentActivity/src/org/sleuthkit/autopsy/recentactivity/SearchEngineURLQueryAnalyzer.java

@@ -333,7 +333,7 @@ class SearchEngineURLQueryAnalyzer extends Extract {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         try{
             services = IngestServices.getDefault();   
             PlatformUtil.extractResourceToUserConfigDir(SearchEngineURLQueryAnalyzer.class, XMLFILE);

SevenZip/src/org/sleuthkit/autopsy/sevenzip/SevenZipIngestModule.java

@@ -113,7 +113,7 @@ public final class SevenZipIngestModule extends IngestModuleAbstractFile {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
         initialized = false;
 

ewfVerify/src/org/sleuthkit/autopsy/ewfverify/EwfVerifyIngestModule.java

@@ -153,7 +153,7 @@ public class EwfVerifyIngestModule extends IngestModuleDataSource {
     }
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
         skCase = Case.getCurrentCase().getSleuthkitCase();
         running = false;

thunderbirdparser/src/org/sleuthkit/autopsy/thunderbirdparser/ThunderbirdMboxFileIngestModule.java

@@ -285,7 +285,7 @@ public class ThunderbirdMboxFileIngestModule extends IngestModuleAbstractFile {
 
 
     @Override
-    public void init(IngestModuleInit initContext) {
+    public void init(IngestModuleInit initContext) throws IngestModuleException {
         services = IngestServices.getDefault();
         fileManager = Case.getCurrentCase().getServices().getFileManager();
     }