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

Inherits org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService, and org.sleuthkit.autopsy.appservices.AutopsyService.

Public Member Functions

void changeOcrState (boolean state)
default void close () throws IOException
void closeCaseResources (CaseContext context) throws AutopsyServiceException
void deleteDataSource (Long dataSourceId) throws KeywordSearchServiceException
void deleteTextIndex (CaseMetadata metadata) throws KeywordSearchServiceException
String getServiceName ()
void index (Content content) throws TskCoreException
void indexArtifact (BlackboardArtifact artifact) throws TskCoreException
void openCaseResources (CaseContext context) throws AutopsyServiceException
void tryConnect (String host, int port) throws KeywordSearchServiceException

Static Private Attributes

static final String BAD_IP_ADDRESS_FORMAT = "ioexception occurred when talking to server"
static final int IS_REACHABLE_TIMEOUT_MS = 1000
static final Logger logger = Logger.getLogger(SolrSearchService.class.getName())
static final String SERVER_REFUSED_CONNECTION = "server refused connection"

Detailed Description

An implementation of the KeywordSearchService interface that uses Solr for text indexing and search.

Definition at line 59 of file

Member Function Documentation

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.changeOcrState ( boolean  state)

A flag to enable or disable OCR on all future text indexing. Also sets the the "Limited OCR" functionality accordingly.

stateBoolean flag to enable/disable OCR. Set to True to enable OCR, or False to disable it.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 478 of file

default void org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.close ( ) throws IOException

Closes the keyword search service.

IOExceptionIf there is a problem closing the file manager.
Do not use.

Definition at line 94 of file

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.closeCaseResources ( CaseContext  context) throws AutopsyServiceException
void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.deleteDataSource ( Long  dataSourceId) throws KeywordSearchServiceException

Deletes a data source from Solr for a case.

dataSourceIdthe id of the data source to delete.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 198 of file

References org.sleuthkit.autopsy.keywordsearch.KeywordSearch.getServer().

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.deleteTextIndex ( CaseMetadata  metadata) throws KeywordSearchServiceException
String org.sleuthkit.autopsy.keywordsearch.SolrSearchService.getServiceName ( )

Gets the service name.

The service name.

Implements org.sleuthkit.autopsy.appservices.AutopsyService.

Definition at line 256 of file

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.index ( Content  content) throws TskCoreException

Indexes the given content for keyword search.

IMPORTANT: Currently, there are two correct uses for this code:

1) Indexing an artifact created during while either the file level ingest module pipeline or the first stage data source level ingest module pipeline of an ingest job is running.

2) Indexing a report.

contentThe content to index.
TskCoreExceptionIf there is a problem indexing the content.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 82 of file

References org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor(), org.sleuthkit.autopsy.ingest.IngestManager.getInstance(), org.sleuthkit.autopsy.textextractors.TextExtractor.getReader(), org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getStringsExtractor(), and org.sleuthkit.autopsy.ingest.IngestManager.isIngestRunning().

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.indexArtifact ( BlackboardArtifact  artifact) throws TskCoreException

Adds an artifact to the keyword search text index as a concantenation of all of its attributes.

artifactThe artifact to index.
Call index(Content) instead.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 447 of file

References org.sleuthkit.autopsy.textextractors.TextExtractorFactory.getExtractor(), and org.sleuthkit.autopsy.textextractors.TextExtractor.getReader().

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.openCaseResources ( CaseContext  context) throws AutopsyServiceException
void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.tryConnect ( String  host,
int  port 
) throws KeywordSearchServiceException

Tries to connect to the keyword search service.

hostThe hostname or IP address of the service.
portThe port used by the service.
KeywordSearchServiceExceptionif cannot connect.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 151 of file

References org.sleuthkit.autopsy.keywordsearch.KeywordSearch.getServer().

Member Data Documentation

final String org.sleuthkit.autopsy.keywordsearch.SolrSearchService.BAD_IP_ADDRESS_FORMAT = "ioexception occurred when talking to server"

Definition at line 61 of file

final int org.sleuthkit.autopsy.keywordsearch.SolrSearchService.IS_REACHABLE_TIMEOUT_MS = 1000

Definition at line 63 of file

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

Definition at line 64 of file

final String org.sleuthkit.autopsy.keywordsearch.SolrSearchService.SERVER_REFUSED_CONNECTION = "server refused connection"

Definition at line 62 of file

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.