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

Classes

enum  MessageType
 

Public Member Functions

boolean equals (Object obj)
 
BlackboardArtifact getData ()
 
Date getDatePosted ()
 
String getDetails ()
 
long getID ()
 
MessageType getMessageType ()
 
String getSource ()
 
String getSubject ()
 
String getUniqueKey ()
 
int hashCode ()
 
String toString ()
 

Static Public Member Functions

static IngestMessage createDataMessage (String source, String subject, String detailsHtml, String uniqueKey, BlackboardArtifact data)
 
static IngestMessage createErrorMessage (String source, String subject, String detailsHtml)
 
static IngestMessage createMessage (MessageType messageType, String source, String subject, String detailsHtml)
 
static IngestMessage createMessage (MessageType messageType, String source, String subject)
 
static IngestMessage createWarningMessage (String source, String subject, String detailsHtml)
 

Private Member Functions

 IngestMessage (long ID, MessageType messageType, String source, String subject, String detailsHtml, String uniqueKey)
 

Private Attributes

BlackboardArtifact data
 
Date datePosted
 
String detailsHtml
 
long ID
 
MessageType messageType
 
String source
 
String subject
 
String uniqueKey
 

Static Private Attributes

static SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")
 
static int managerMessageId = 0
 
static AtomicLong nextMessageID = new AtomicLong(0)
 

Detailed Description

Message that ingestmodule wants to send to IngetInbox to notify user about something. Submitted to user via IngestServices. Create using factory methods.

Definition at line 32 of file IngestMessage.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.ingest.IngestMessage.IngestMessage ( long  ID,
MessageType  messageType,
String  source,
String  subject,
String  detailsHtml,
String  uniqueKey 
)
private

Member Function Documentation

static IngestMessage org.sleuthkit.autopsy.ingest.IngestMessage.createDataMessage ( String  source,
String  subject,
String  detailsHtml,
String  uniqueKey,
BlackboardArtifact  data 
)
static
Parameters
sourceoriginating module
subjectmessage subject to be displayed
detailsHtmlhtml formatted detailed message (without leading and closing <html> tags), for instance, a human-readable representation of the data. Or null.
uniqueKeyKey used to group similar messages together. Shoudl be unique to the analysis. For example, hits for the same keyword in a keyword search would use the keyword as this unique value so that they can be grouped.
datablackboard artifact associated with the message, the same as fired in ModuleDataEvent by the module
Returns

Definition at line 261 of file IngestMessage.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.DATA, org.sleuthkit.autopsy.ingest.IngestMessage.data, and org.sleuthkit.autopsy.ingest.IngestMessage.IngestMessage().

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postHashSetHitToBlackboard().

static IngestMessage org.sleuthkit.autopsy.ingest.IngestMessage.createErrorMessage ( String  source,
String  subject,
String  detailsHtml 
)
static

Create error message

Parameters
sourceoriginating module
subjectmessage subject to be displayed
detailsHtmlhtml formatted detailed message (without leading and closing <html> tags), for instance, a human-readable representation of the data. Or null
Returns

Definition at line 216 of file IngestMessage.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.ERROR, and org.sleuthkit.autopsy.ingest.IngestMessage.IngestMessage().

Referenced by org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.process(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processVcard(), and org.sleuthkit.autopsy.keywordsearch.IngestSearchRunner.PeriodicSearchTask.run().

static IngestMessage org.sleuthkit.autopsy.ingest.IngestMessage.createMessage ( MessageType  messageType,
String  source,
String  subject,
String  detailsHtml 
)
static
static IngestMessage org.sleuthkit.autopsy.ingest.IngestMessage.createMessage ( MessageType  messageType,
String  source,
String  subject 
)
static

Create a simple message with a subject only

Parameters
messageTypemessage type
sourceoriginating module
subjectmessage subject to be displayed
Returns

Definition at line 201 of file IngestMessage.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.createMessage().

static IngestMessage org.sleuthkit.autopsy.ingest.IngestMessage.createWarningMessage ( String  source,
String  subject,
String  detailsHtml 
)
static

Create warning message

Parameters
sourceoriginating module
subjectmessage subject to be displayed
detailsHtmlhtml formatted detailed message (without leading and closing <html> tags), for instance, a human-readable representation of the data. Or null
Returns

Definition at line 236 of file IngestMessage.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.IngestMessage(), and org.sleuthkit.autopsy.ingest.IngestMessage.MessageType.WARNING.

Referenced by org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.startUp(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

boolean org.sleuthkit.autopsy.ingest.IngestMessage.equals ( Object  obj)
BlackboardArtifact org.sleuthkit.autopsy.ingest.IngestMessage.getData ( )
Date org.sleuthkit.autopsy.ingest.IngestMessage.getDatePosted ( )
String org.sleuthkit.autopsy.ingest.IngestMessage.getDetails ( )
long org.sleuthkit.autopsy.ingest.IngestMessage.getID ( )

Definition at line 72 of file IngestMessage.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.ID.

MessageType org.sleuthkit.autopsy.ingest.IngestMessage.getMessageType ( )
String org.sleuthkit.autopsy.ingest.IngestMessage.getSource ( )
String org.sleuthkit.autopsy.ingest.IngestMessage.getSubject ( )
String org.sleuthkit.autopsy.ingest.IngestMessage.getUniqueKey ( )
int org.sleuthkit.autopsy.ingest.IngestMessage.hashCode ( )

Definition at line 159 of file IngestMessage.java.

String org.sleuthkit.autopsy.ingest.IngestMessage.toString ( )

Member Data Documentation

BlackboardArtifact org.sleuthkit.autopsy.ingest.IngestMessage.data
private
SimpleDateFormat org.sleuthkit.autopsy.ingest.IngestMessage.dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")
staticprivate

Definition at line 50 of file IngestMessage.java.

Date org.sleuthkit.autopsy.ingest.IngestMessage.datePosted
private
String org.sleuthkit.autopsy.ingest.IngestMessage.detailsHtml
private
long org.sleuthkit.autopsy.ingest.IngestMessage.ID
private
int org.sleuthkit.autopsy.ingest.IngestMessage.managerMessageId = 0
staticprivate

Definition at line 51 of file IngestMessage.java.

MessageType org.sleuthkit.autopsy.ingest.IngestMessage.messageType
private
AtomicLong org.sleuthkit.autopsy.ingest.IngestMessage.nextMessageID = new AtomicLong(0)
staticprivate

Definition at line 52 of file IngestMessage.java.

String org.sleuthkit.autopsy.ingest.IngestMessage.source
private
String org.sleuthkit.autopsy.ingest.IngestMessage.subject
private
String org.sleuthkit.autopsy.ingest.IngestMessage.uniqueKey
private

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

Copyright © 2012-2018 Basis Technology. Generated on: Fri Mar 22 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.