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

void close () throws IOException
 
void closeCaseResources (CaseContext context) throws AutopsyServiceException
 
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 GIANT_INDEX_SIZE_GB = 500
 
static final int IS_REACHABLE_TIMEOUT_MS = 1000
 
static final int LARGE_INDEX_SIZE_GB = 50
 
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.

Definition at line 61 of file SolrSearchService.java.

Member Function Documentation

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.close ( ) throws IOException

Definition at line 229 of file SolrSearchService.java.

void org.sleuthkit.autopsy.keywordsearch.SolrSearchService.closeCaseResources ( CaseContext  context) throws AutopsyServiceException
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 233 of file SolrSearchService.java.

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

Indexes the given content for keyword search.

IMPORTANT: Currently, there are two correct uses for this code:

1) Indexing an artifact created during while either the file level ingest module pipeline or the first stage data source level ingest module pipeline of an ingest job is running.

2) Indexing a report.

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

Implements org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.

Definition at line 86 of file SolrSearchService.java.

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 427 of file SolrSearchService.java.

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 144 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 63 of file SolrSearchService.java.

final int org.sleuthkit.autopsy.keywordsearch.SolrSearchService.GIANT_INDEX_SIZE_GB = 500
staticprivate

Definition at line 67 of file SolrSearchService.java.

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

Definition at line 65 of file SolrSearchService.java.

final int org.sleuthkit.autopsy.keywordsearch.SolrSearchService.LARGE_INDEX_SIZE_GB = 50
staticprivate

Definition at line 66 of file SolrSearchService.java.

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

Definition at line 68 of file SolrSearchService.java.

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

Definition at line 64 of file SolrSearchService.java.


The documentation for this class 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.