Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings Class Reference

Inherits org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings.

Public Member Functions

 GenericIngestModuleJobSettings ()
 
String getSetting (String key)
 
long getVersionNumber ()
 
void removeSetting (String key)
 
void setSetting (String key, String value)
 

Private Attributes

final Map< String, String > settings
 

Static Private Attributes

static final long serialVersionUID = 1L
 

Detailed Description

Generic Ingest Job settings class. Primary use of this class is for Python modules because classes created in Python cannot be serialized / deserialized in Java.

Definition at line 29 of file GenericIngestModuleJobSettings.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.GenericIngestModuleJobSettings ( )

Definition at line 39 of file GenericIngestModuleJobSettings.java.

Member Function Documentation

String org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.getSetting ( String  key)

Return the string value for passed key parameter.

Parameters
keyThe key to lookup
Returns
The value or null if the key was not found.

Definition at line 49 of file GenericIngestModuleJobSettings.java.

long org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.getVersionNumber ( )

Returns the version number of the settings object. The version number should be a private final static long per the documentation of the Serializable interface.

Returns
A serialization version number.

Implements org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings.

Definition at line 33 of file GenericIngestModuleJobSettings.java.

References org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.serialVersionUID.

void org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.removeSetting ( String  key)

Removes the key from the settings.

Parameters
keyThe key to be removed

Definition at line 67 of file GenericIngestModuleJobSettings.java.

void org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.setSetting ( String  key,
String  value 
)

Adds the passed key value pair

Parameters
keyThe key to be added to the settings
valueThe value to be added for the key

Definition at line 59 of file GenericIngestModuleJobSettings.java.

Member Data Documentation

final long org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.serialVersionUID = 1L
staticprivate
final Map<String, String> org.sleuthkit.autopsy.ingest.GenericIngestModuleJobSettings.settings
private

Definition at line 37 of file GenericIngestModuleJobSettings.java.


The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.