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	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)

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

Case.getCurrentCase().getServices().getKeywordSearchService()

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

Definition at line 40 of file KeywordSearchService.java.

Member Function Documentation

default void org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.close

(

)

throws IOException

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.keywordsearchservice.KeywordSearchService.deleteTextIndex

(

CaseMetadata

metadata

)

throws KeywordSearchServiceException

Deletes the keyword search text index for a case.

Parameters

metadata

The CaseMetadata which will have its core deleted.

Exceptions

KeywordSearchServiceException

if 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.

Parameters

content

The content to index.

Exceptions

TskCoreException

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.

Parameters

artifact

The artifact to index.

Deprecated:

Call org.sleuthkit.datamodel.Blackboard.postArtifact instead.

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

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

Exceptions

KeywordSearchServiceException

if 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:

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java