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

Public Member Functions
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	GIANT_INDEX_SIZE_GB = 500

static final int	IS_REACHABLE_TIMEOUT_MS = 1000

static final int	LARGE_INDEX_SIZE_GB = 50

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 66 of file SolrSearchService.java.

Member Function Documentation

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

inherited

Closes the keyword search service.

Exceptions

IOException If there is a problem closing the file manager.

Deprecated:: Do not use.

Definition at line 93 of file KeywordSearchService.java.

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.closeCaseResources ( CaseContext context ) throws AutopsyServiceException

Closes the open core.

Parameters

context

Exceptions

org.sleuthkit.autopsy.appservices.AutopsyService.AutopsyServiceException

Implements org.sleuthkit.autopsy.appservices.AutopsyService.

Definition at line 428 of file SolrSearchService.java.

References org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.getCase(), org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory(), org.sleuthkit.autopsy.keywordsearch.KeywordSearch.getServer(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.deleteDataSource ( Long dataSourceId ) throws KeywordSearchServiceException

Deletes a data source from Solr for a case.

Parameters

dataSourceId the id of the data source to delete.

Exceptions

org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchServiceException

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 205 of file SolrSearchService.java.

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

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

Deletes Solr core for a case.

Parameters

metadata The CaseMetadata which will have its core deleted.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 227 of file SolrSearchService.java.

References org.sleuthkit.autopsy.coreutils.FileUtil.deleteDir(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearch.getServer().

String org.sleuthkit.autopsy.keywordsearch.SolrSearchService.getServiceName ( )

Gets the service name.

Returns: The service name.

Implements org.sleuthkit.autopsy.appservices.AutopsyService.

Definition at line 261 of file SolrSearchService.java.

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.

Parameters

content The content to index.

Exceptions

TskCoreException If there is a problem indexing the content.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 91 of file SolrSearchService.java.

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

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.

Parameters

artifact The artifact to index.

Exceptions

org.sleuthkit.datamodel.TskCoreException

Deprecated:: Call index(Content) instead.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 484 of file SolrSearchService.java.

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

Creates/opens the Solr core/text index for a case

Parameters

context The case context.

Exceptions

org.sleuthkit.autopsy.appservices.AutopsyService.AutopsyServiceException

Implements org.sleuthkit.autopsy.appservices.AutopsyService.

Definition at line 285 of file SolrSearchService.java.

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

Tries to connect to the keyword search service.

Parameters

host	The hostname or IP address of the service.
port	The port used by the service.

Exceptions

KeywordSearchServiceException if cannot connect.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 156 of file SolrSearchService.java.

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"

staticprivate

Definition at line 68 of file SolrSearchService.java.

final int org.sleuthkit.autopsy.keywordsearch.SolrSearchService.GIANT_INDEX_SIZE_GB = 500

staticprivate

Definition at line 72 of file SolrSearchService.java.

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

staticprivate

Definition at line 70 of file SolrSearchService.java.

final int org.sleuthkit.autopsy.keywordsearch.SolrSearchService.LARGE_INDEX_SIZE_GB = 50

staticprivate

Definition at line 71 of file SolrSearchService.java.

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

staticprivate

Definition at line 73 of file SolrSearchService.java.

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

staticprivate

Definition at line 69 of file SolrSearchService.java.

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

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

Public Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation