Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService Interface Reference

Inherits Closeable.

Inherited by org.sleuthkit.autopsy.keywordsearch.SolrSearchService.

Public Member Functions

default void close () throws IOException
void deleteDataSource (Long dataSourceId) throws KeywordSearchServiceException
void deleteTextIndex (CaseMetadata metadata) throws KeywordSearchServiceException
void index (Content content) throws TskCoreException
void indexArtifact (BlackboardArtifact artifact) throws TskCoreException
void tryConnect (String host, int port) throws KeywordSearchServiceException

Detailed Description

An interface for implementations of a keyword search service. You can find the implementations by using Lookup, such as:


although most clients should obtain a keyword search service by calling:


TODO (AUT-2158): This interface should not extend Closeable.

Definition at line 41 of file

Member Function Documentation

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.keywordsearchservice.KeywordSearchService.deleteDataSource ( Long  dataSourceId) throws KeywordSearchServiceException

Deletes the keyword search text for a specific data source.

dataSourceIdThe data source id to be deleted.
KeywordSearchServiceExceptionif unable to delete.

Implemented in org.sleuthkit.autopsy.keywordsearch.SolrSearchService.

void org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.deleteTextIndex ( CaseMetadata  metadata) throws KeywordSearchServiceException

Deletes the keyword search text index for a case.

metadataThe CaseMetadata which will have its core deleted.
KeywordSearchServiceExceptionif unable to delete.

Implemented in org.sleuthkit.autopsy.keywordsearch.SolrSearchService.

void org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.index ( Content  content) throws TskCoreException

Add the given Content object to the text index. This message should only be used in atypical cases, such as indexing a report. Artifacts are indexed when org.sleuthkit.datamodel.Blackboard.postArtifact is called and files are indexed during ingest.

contentThe content to index.

Implemented in org.sleuthkit.autopsy.keywordsearch.SolrSearchService.

void org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.indexArtifact ( BlackboardArtifact  artifact) throws TskCoreException

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

artifactThe artifact to index.
Call org.sleuthkit.datamodel.Blackboard.postArtifact instead.

Implemented in org.sleuthkit.autopsy.keywordsearch.SolrSearchService.

void org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.tryConnect ( String  host,
int  port 
) throws KeywordSearchServiceException

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

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