Autopsy  4.7.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

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: Lookup.getDefault().lookup(KeywordSearchService.class)

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

Definition at line 34 of file KeywordSearchService.java.

Member Function Documentation

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

Deletes the keyword search text index for a case.

Parameters
metadataThe CaseMetadata which will have its core deleted.
Exceptions
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.

Parameters
contentThe content to index.
Exceptions
TskCoreException

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

Referenced by org.sleuthkit.autopsy.casemodule.services.Blackboard.indexArtifact().

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.

Parameters
artifactThe artifact to index.
Exceptions
org.sleuthkit.datamodel.TskCoreException

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

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

Tries to connect to the keyword search service server.

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

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

Referenced by org.sleuthkit.autopsy.corecomponents.MultiUserSettingsPanel.bnTestSolrActionPerformed(), org.sleuthkit.autopsy.core.ServicesMonitor.checkKeywordSearchServerConnectionStatus(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().


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

Copyright © 2012-2016 Basis Technology. Generated on: Mon Jun 18 2018
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.