org.sleuthkit.autopsy.keywordsearch.SolrSearchService Class Reference

Inherits org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Public Member Functions
void	close () throws IOException
void	indexArtifact (BlackboardArtifact artifact) throws TskCoreException
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 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 47 of file SolrSearchService.java.

Member Function Documentation

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.close

(

)

throws IOException

Definition at line 228 of file SolrSearchService.java.

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.indexArtifact

(

BlackboardArtifact

artifact

)

throws TskCoreException

Takes a Blackboard artifact and adds all of its attributes to the keyword search index.

Parameters

artifact

Exceptions

org.sleuthkit.datamodel.TskCoreException

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 54 of file SolrSearchService.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase(), and org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime().

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

Checks if we can communicate with Solr using the passed-in host and port. Closes the connection upon exit. Throws if it cannot communicate with Solr.

When issues occur, it attempts to diagnose them by looking at the exception messages, returning the appropriate user-facing text for the exception received. This method expects the Exceptions messages to be in English and compares against English text.

Parameters

host	the remote hostname or IP address of the Solr server
port	the remote port for Solr

Exceptions

org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchServiceException

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

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

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

staticprivate

Definition at line 51 of file SolrSearchService.java.

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

staticprivate

Definition at line 50 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