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

Private constructor used by factory methods

Definition at line 57 of file IngestMessage.java.

References org.sleuthkit.autopsy.ingest.IngestMessage.detailsHtml, org.sleuthkit.autopsy.ingest.IngestMessage.ID, org.sleuthkit.autopsy.ingest.IngestMessage.messageType, org.sleuthkit.autopsy.ingest.IngestMessage.source, org.sleuthkit.autopsy.ingest.IngestMessage.subject, and org.sleuthkit.autopsy.ingest.IngestMessage.uniqueKey.

Referenced by org.sleuthkit.autopsy.ingest.IngestMessage.createDataMessage(), org.sleuthkit.autopsy.ingest.IngestMessage.createErrorMessage(), org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.ingest.IngestMessage.createWarningMessage(), and org.sleuthkit.autopsy.ingest.IngestMessage.equals().

Member Function Documentation

static IngestMessage org.sleuthkit.autopsy.ingest.IngestMessage.createDataMessage	(	String	source,
		String	subject,
		String	detailsHtml,
		String	uniqueKey,
		BlackboardArtifact	data
	)

static

Parameters

source	originating module
subject	message subject to be displayed
detailsHtml	html formatted detailed message (without leading and closing <html> tags), for instance, a human-readable representation of the data. Or null.
uniqueKey	Key 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.
data	blackboard 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

source	originating module
subject	message subject to be displayed
detailsHtml	html 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(), 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

Create a message of specified type

Parameters

messageType	message type
source	originating module
subject	message subject to be displayed
detailsHtml	html formatted detailed message (without leading and closing <html> tags), for instance, a human-readable representation of the data. Or null.

Returns

Definition at line 183 of file IngestMessage.java.

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

Referenced by org.sleuthkit.autopsy.ingest.IngestMessage.createMessage(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.postIndexSummary(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbIngestModule.postSummary(), org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.process(), org.sleuthkit.autopsy.modules.dataSourceIntegrity.DataSourceIntegrityIngestModule.process(), org.sleuthkit.autopsy.modules.filetypeid.FileTypeIdIngestModule.shutDown(), and org.sleuthkit.autopsy.modules.fileextmismatch.FileExtMismatchIngestModule.shutDown().

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

static

Create a simple message with a subject only

Parameters

messageType	message type
source	originating module
subject	message 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

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