Update documentation of data source id

This commit is contained in:
Richard Cordovano 2016-01-25 18:08:27 -05:00
parent 1ef268c258
commit 2bf0c91929
3 changed files with 40 additions and 9 deletions

View File

@ -113,14 +113,44 @@ class AddImageTask implements Runnable {
} }
} }
AddImageTask(String dataSourceId, String imgPath, String tz, boolean noOrphans, DataSourceProcessorProgressMonitor aProgressMonitor, DataSourceProcessorCallback cbObj) { /**
* Runs the data source processor in a separate thread without requiring use
* the configuration panel.
*
* @param dataSourceId An ASCII-printable identifier for the data
* source that is unique across multiple cases
* (e.g., a UUID).
* @param imagePath Path to the image file.
* @param timeZone The time zone to use when processing dates
* and times for the image, obtained from
* java.util.TimeZone.getID.
* @param ignoreFatOrphanFiles Whether to parse orphans if the image has a
* FAT filesystem.
* @param monitor Progress monitor to report progress during
* processing.
* @param cbObj Callback to call when processing is done.
*/
/**
* Constructs a runnable task that adds an image to the case database.
*
* @param imagePath Path to the image file.
* @param timeZone The time zone to use when processing dates
* and times for the image, obtained from
* java.util.TimeZone.getID.
* @param ignoreFatOrphanFiles Whether to parse orphans if the image has a
* FAT filesystem.
* @param monitor Progress monitor to report progress during
* processing.
* @param cbObj Callback to call when processing is done.
*/
AddImageTask(String dataSourceId, String imagePath, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor monitor, DataSourceProcessorCallback cbObj) {
currentCase = Case.getCurrentCase(); currentCase = Case.getCurrentCase();
this.dataSourceId = dataSourceId; this.dataSourceId = dataSourceId;
this.imagePath = imgPath; this.imagePath = imagePath;
this.timeZone = tz; this.timeZone = timeZone;
this.noFatOrphans = noOrphans; this.noFatOrphans = ignoreFatOrphanFiles;
this.callbackObj = cbObj; this.callbackObj = cbObj;
this.progressMonitor = aProgressMonitor; this.progressMonitor = monitor;
} }
/** /**
@ -141,7 +171,7 @@ class AddImageTask implements Runnable {
progressMonitor.setIndeterminate(true); progressMonitor.setIndeterminate(true);
progressMonitor.setProgress(0); progressMonitor.setProgress(0);
dirFetcher.start(); dirFetcher.start();
addImageProcess.run(dataSourceId, imagePath); addImageProcess.run(dataSourceId, new String[]{imagePath});
} catch (TskCoreException ex) { } catch (TskCoreException ex) {
logger.log(Level.SEVERE, "Core errors occurred while running add image. ", ex); //NON-NLS logger.log(Level.SEVERE, "Core errors occurred while running add image. ", ex); //NON-NLS
hasCritError = true; hasCritError = true;

View File

@ -147,7 +147,7 @@ public class ImageDSProcessor implements DataSourceProcessor {
* Runs the data source processor in a separate thread without requiring use * Runs the data source processor in a separate thread without requiring use
* the configuration panel. * the configuration panel.
* *
* @param dataSourceId A identifier for the data source that is * @param dataSourceId An ASCII-printable identifier for the data source that is
* unique across multiple cases (e.g., a UUID). * unique across multiple cases (e.g., a UUID).
* @param imagePath Path to the image file. * @param imagePath Path to the image file.
* @param timeZone The time zone to use when processing dates * @param timeZone The time zone to use when processing dates

View File

@ -130,8 +130,9 @@ public class LocalDiskDSProcessor implements DataSourceProcessor {
* Runs the data source processor in a separate thread without requiring use * Runs the data source processor in a separate thread without requiring use
* the configuration panel. * the configuration panel.
* *
* @param dataSourceId A identifier for the data source that is * @param dataSourceId An ASCII-printable identifier for the data
* unique across multiple cases (e.g., a UUID). * source that is unique across multiple cases
* (e.g., a UUID).
* @param drivePath Path to the local drive. * @param drivePath Path to the local drive.
* @param timeZone The time zone to use when processing dates * @param timeZone The time zone to use when processing dates
* and times for the image, obtained from * and times for the image, obtained from