org.sleuthkit.autopsy.keywordsearch.SearchRunner Class Reference

Classes
class	Searcher
class	SearchJobInfo
class	UpdateTimerTask

Public Member Functions
synchronized void	addKeywordListsToAllJobs (List< String > keywordListNames)
void	endJob (long jobId)
synchronized void	startJob (long jobId, long dataSourceId, List< String > keywordListNames)
void	stopJob (long jobId)

Static Public Member Functions
static synchronized SearchRunner	getInstance ()

Private Member Functions
void	commit ()
void	doFinalSearch (SearchJobInfo job)

Private Attributes
Ingester	ingester = null
Map< Long, SearchJobInfo >	jobs = new HashMap<>()
IngestServices	services = IngestServices.getInstance()
Timer	updateTimer
volatile boolean	updateTimerRunning = false

Static Private Attributes
static SearchRunner	instance = null
static final Logger	logger = Logger.getLogger(SearchRunner.class.getName())

Detailed Description

Singleton keyword search manager: Launches search threads for each job and performs commits, both on timed intervals.

Definition at line 55 of file SearchRunner.java.

Member Function Documentation

synchronized void org.sleuthkit.autopsy.keywordsearch.SearchRunner.addKeywordListsToAllJobs

(

List< String >

keywordListNames

)

Add these lists to all of the jobs. Used when user wants to search for a list while ingest has already started.

Parameters

keywordListNames

Definition at line 172 of file SearchRunner.java.

void org.sleuthkit.autopsy.keywordsearch.SearchRunner.commit ( )

private

Commits index and notifies listeners of index update

Definition at line 184 of file SearchRunner.java.

References org.sleuthkit.autopsy.keywordsearch.KeywordSearch.fireNumIndexedFilesChange(), org.sleuthkit.autopsy.keywordsearch.KeywordSearch.getServer(), and org.sleuthkit.autopsy.keywordsearch.Server.queryNumIndexedFiles().

Referenced by org.sleuthkit.autopsy.keywordsearch.SearchRunner.endJob(), org.sleuthkit.autopsy.keywordsearch.SearchRunner.UpdateTimerTask.run(), and org.sleuthkit.autopsy.keywordsearch.SearchRunner.stopJob().

void org.sleuthkit.autopsy.keywordsearch.SearchRunner.doFinalSearch ( SearchJobInfo  job )

private

A final search waits for any still-running workers, and then executes a new one and waits until that is done.

Parameters

job

Definition at line 202 of file SearchRunner.java.

References org.sleuthkit.autopsy.keywordsearch.SearchRunner.SearchJobInfo.getJobId(), org.sleuthkit.autopsy.keywordsearch.SearchRunner.SearchJobInfo.getKeywordListNames(), org.sleuthkit.autopsy.keywordsearch.SearchRunner.SearchJobInfo.setCurrentSearcher(), and org.sleuthkit.autopsy.keywordsearch.SearchRunner.SearchJobInfo.waitForCurrentWorker().

Referenced by org.sleuthkit.autopsy.keywordsearch.SearchRunner.endJob().

void org.sleuthkit.autopsy.keywordsearch.SearchRunner.endJob

(

long

jobId

)

Perform normal finishing of searching for this job, including one last commit and search. Blocks until the final search is complete.

Parameters

jobId

Definition at line 117 of file SearchRunner.java.

References org.sleuthkit.autopsy.keywordsearch.SearchRunner.commit(), org.sleuthkit.autopsy.keywordsearch.SearchRunner.SearchJobInfo.decrementModuleReferenceCount(), and org.sleuthkit.autopsy.keywordsearch.SearchRunner.doFinalSearch().

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown().

static synchronized SearchRunner org.sleuthkit.autopsy.keywordsearch.SearchRunner.getInstance ( )

static

Returns

the singleton object

Definition at line 76 of file SearchRunner.java.

References org.sleuthkit.autopsy.keywordsearch.SearchRunner.instance.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.process(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.stop().

synchronized void org.sleuthkit.autopsy.keywordsearch.SearchRunner.startJob	(	long	jobId,
		long	dataSourceId,
		List< String >	keywordListNames
	)

Add a new job. Searches will be periodically performed after this is called.

Parameters

jobId	Job ID that this is associated with
dataSourceId	Data source that is being indexed and that searches should be restricted to.
keywordListNames	List of keyword lists that will be searched. List contents will be refreshed each search.

Definition at line 93 of file SearchRunner.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.process().

void org.sleuthkit.autopsy.keywordsearch.SearchRunner.stopJob

(

long

jobId

)

Immediate stop and removal of job from SearchRunner. Cancels the associated search worker if it's still running.

Parameters

jobId

Definition at line 145 of file SearchRunner.java.

References org.sleuthkit.autopsy.keywordsearch.SearchRunner.commit(), and org.sleuthkit.autopsy.keywordsearch.SearchRunner.SearchJobInfo.getCurrentSearcher().

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.stop().

Member Data Documentation

Ingester org.sleuthkit.autopsy.keywordsearch.SearchRunner.ingester = null

private

Definition at line 60 of file SearchRunner.java.

SearchRunner org.sleuthkit.autopsy.keywordsearch.SearchRunner.instance = null

staticprivate

Definition at line 58 of file SearchRunner.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.SearchRunner.getInstance().

Map<Long, SearchJobInfo> org.sleuthkit.autopsy.keywordsearch.SearchRunner.jobs = new HashMap<>()

private

Definition at line 65 of file SearchRunner.java.

final Logger org.sleuthkit.autopsy.keywordsearch.SearchRunner.logger = Logger.getLogger(SearchRunner.class.getName())

staticprivate

Definition at line 57 of file SearchRunner.java.

IngestServices org.sleuthkit.autopsy.keywordsearch.SearchRunner.services = IngestServices.getInstance()

private

Definition at line 59 of file SearchRunner.java.

Timer org.sleuthkit.autopsy.keywordsearch.SearchRunner.updateTimer

private

Definition at line 62 of file SearchRunner.java.

volatile boolean org.sleuthkit.autopsy.keywordsearch.SearchRunner.updateTimerRunning = false

private

Definition at line 61 of file SearchRunner.java.

---

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

• /home/carriersleuth/repos/autopsy/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/SearchRunner.java