Autopsy  4.19.3
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

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.

NOTE: UserPreferences.isMultiUserSupported relies on this class being found. Changes to the name or package of this class will need to be reflected in UserPreferences.isMultiUserSupported.

Definition at line 60 of file SolrSearchService.java.

Member Function Documentation

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

Closes the keyword search service.

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

Definition at line 94 of file KeywordSearchService.java.

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.

Parameters
dataSourceIdthe id of the data source to delete.
Exceptions
org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchServiceException

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 183 of file SolrSearchService.java.

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.

Returns
The service name.

Implements org.sleuthkit.autopsy.appservices.AutopsyService.

Definition at line 241 of file SolrSearchService.java.

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

Indexes the given content for keyword search.

IMPORTANT: This indexes the given content, but does not execute a keyword search. For the text of the content to be searched, the indexing has to occur either in the context of an ingest job configured for keyword search, or in the context of an ad hoc keyword search.

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

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 80 of file SolrSearchService.java.

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.

Parameters
artifactThe artifact to index.
Exceptions
org.sleuthkit.datamodel.TskCoreException
Deprecated:
Call index(Content) instead.

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 410 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
void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.tryConnect ( String  host,
int  port 
) throws KeywordSearchServiceException

Tries to connect to the keyword search service.

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

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 136 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 62 of file SolrSearchService.java.

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

Definition at line 64 of file SolrSearchService.java.

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

Definition at line 65 of file SolrSearchService.java.

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

Definition at line 63 of file SolrSearchService.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Fri Oct 7 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.