Autopsy  3.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.keywordsearch.Server Class Reference

Classes

class  Core
 
enum  CORE_EVT_STATES
 
class  InputStreamPrinterThread
 
enum  Schema
 
class  ServerAction
 
class  SolrServerNoPortException
 

Public Member Functions

void finalize () throws java.lang.Throwable
 
void addServerActionListener (PropertyChangeListener l)
 
int queryNumIndexedFiles () throws KeywordSearchModuleException, NoOpenCoreException
 
int queryNumIndexedChunks () throws KeywordSearchModuleException, NoOpenCoreException
 
int queryNumIndexedDocuments () throws KeywordSearchModuleException, NoOpenCoreException
 
boolean queryIsIndexed (long contentID) throws KeywordSearchModuleException, NoOpenCoreException
 
int queryNumFileChunks (long fileID) throws KeywordSearchModuleException, NoOpenCoreException
 
QueryResponse query (SolrQuery sq) throws KeywordSearchModuleException, NoOpenCoreException
 
QueryResponse query (SolrQuery sq, SolrRequest.METHOD method) throws KeywordSearchModuleException, NoOpenCoreException
 
TermsResponse queryTerms (SolrQuery sq) throws KeywordSearchModuleException, NoOpenCoreException
 
String getSolrContent (final Content content) throws NoOpenCoreException
 
String getSolrContent (final Content content, int chunkID) throws NoOpenCoreException
 

Static Public Member Functions

static Ingester getIngester ()
 
static String getChunkIdString (long parentID, int childID)
 

Static Public Attributes

static final String HL_ANALYZE_CHARS_UNLIMITED = "500000"
 
static final long MAX_CONTENT_SIZE = 1L * 1024 * 1024 * 1024
 
static final String CORE_EVT = "CORE_EVT"
 
static final char ID_CHUNK_SEP = '_'
 
static final Charset DEFAULT_INDEXED_TEXT_CHARSET = Charset.forName("UTF-8")
 default Charset to index text as More...
 

Private Member Functions

void initSettings ()
 
void validateIndexLocation (Case theCase)
 
synchronized Core openCore (Case theCase) throws KeywordSearchModuleException
 
Core openCore (String coreName, File dataDir) throws KeywordSearchModuleException
 

Private Attributes

String javaPath = "java"
 
Process curSolrProcess = null
 
int currentSolrServerPort = 0
 
int currentSolrStopPort = 0
 
SolrServer solrServer
 
String instanceDir
 
File solrFolder
 
ServerAction serverAction
 
InputStreamPrinterThread errorRedirectThread
 
String solrUrl
 
volatile Core currentCore = null
 

Static Private Attributes

static final Logger logger = Logger.getLogger(Server.class.getName())
 
static final String DEFAULT_CORE_NAME = "coreCase"
 
static final int MAX_SOLR_MEM_MB = 512
 
static Ingester ingester = null
 
static final String KEY = "jjk#09s"
 
static final boolean DEBUG = false
 

Detailed Description

Handles for keeping track of a Solr server and its cores

Definition at line 69 of file Server.java.

Member Function Documentation

void org.sleuthkit.autopsy.keywordsearch.Server.addServerActionListener ( PropertyChangeListener  l)

Definition at line 229 of file Server.java.

void org.sleuthkit.autopsy.keywordsearch.Server.finalize ( ) throws java.lang.Throwable

Definition at line 224 of file Server.java.

static String org.sleuthkit.autopsy.keywordsearch.Server.getChunkIdString ( long  parentID,
int  childID 
)
static

Given file parent id and child chunk ID, return the ID string of the chunk as stored in Solr, e.g. FILEID_CHUNKID

Parameters
parentIDthe parent file id (id of the source content)
childIDthe child chunk id
Returns
formatted string id

Definition at line 906 of file Server.java.

References org.sleuthkit.autopsy.keywordsearch.Server.ID_CHUNK_SEP.

static Ingester org.sleuthkit.autopsy.keywordsearch.Server.getIngester ( )
static

Method to return ingester instance

Returns
ingester instance

Definition at line 894 of file Server.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

String org.sleuthkit.autopsy.keywordsearch.Server.getSolrContent ( final Content  content) throws NoOpenCoreException

Get the text contents of the given file as stored in SOLR.

Parameters
contentto get the text for
Returns
content text string or null on error
Exceptions
NoOpenCoreException

Definition at line 839 of file Server.java.

String org.sleuthkit.autopsy.keywordsearch.Server.getSolrContent ( final Content  content,
int  chunkID 
) throws NoOpenCoreException

Get the text contents of a single chunk for the given file as stored in SOLR.

Parameters
contentto get the text for
chunkIDchunk number to query (starting at 1), or 0 if there is no chunks for that content
Returns
content text string or null if error quering
Exceptions
NoOpenCoreException

Definition at line 855 of file Server.java.

void org.sleuthkit.autopsy.keywordsearch.Server.initSettings ( )
private
synchronized Core org.sleuthkit.autopsy.keywordsearch.Server.openCore ( Case  theCase) throws KeywordSearchModuleException
private

** end single-case specific methods *** Open a core for the given case

Parameters
theCasethe case to open core for
Returns

Definition at line 643 of file Server.java.

Core org.sleuthkit.autopsy.keywordsearch.Server.openCore ( String  coreName,
File  dataDir 
) throws KeywordSearchModuleException
private

Open a new core

Parameters
coreNamename to refer to the core by in Solr
dataDirdirectory to load/store the core data from/to
Returns
new core

Definition at line 917 of file Server.java.

QueryResponse org.sleuthkit.autopsy.keywordsearch.Server.query ( SolrQuery  sq) throws KeywordSearchModuleException, NoOpenCoreException

Execute solr query

Parameters
sqquery
Returns
query response
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 779 of file Server.java.

QueryResponse org.sleuthkit.autopsy.keywordsearch.Server.query ( SolrQuery  sq,
SolrRequest.METHOD  method 
) throws KeywordSearchModuleException, NoOpenCoreException

Execute solr query

Parameters
sqthe query
methodhttp method to use
Returns
query response
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 800 of file Server.java.

boolean org.sleuthkit.autopsy.keywordsearch.Server.queryIsIndexed ( long  contentID) throws KeywordSearchModuleException, NoOpenCoreException

Return true if the file is indexed (either as a whole as a chunk)

Parameters
contentID
Returns
true if it is indexed
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 738 of file Server.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.ExtractedContentViewer.solrHasContent().

int org.sleuthkit.autopsy.keywordsearch.Server.queryNumFileChunks ( long  fileID) throws KeywordSearchModuleException, NoOpenCoreException

Execute query that gets number of indexed file chunks for a file

Parameters
fileIDfile id of the original file broken into chunks and indexed
Returns
int representing number of indexed file chunks, 0 if there is no chunks
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 759 of file Server.java.

int org.sleuthkit.autopsy.keywordsearch.Server.queryNumIndexedChunks ( ) throws KeywordSearchModuleException, NoOpenCoreException

Execute query that gets only number of all Solr file chunks (not logical files) indexed without actually returning the content.

Returns
int representing number of indexed chunks
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 698 of file Server.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown().

int org.sleuthkit.autopsy.keywordsearch.Server.queryNumIndexedDocuments ( ) throws KeywordSearchModuleException, NoOpenCoreException

Execute query that gets only number of all Solr documents indexed (files and chunks) without actually returning the documents

Returns
int representing number of indexed files (files and chunks)
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 718 of file Server.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp().

int org.sleuthkit.autopsy.keywordsearch.Server.queryNumIndexedFiles ( ) throws KeywordSearchModuleException, NoOpenCoreException

Execute query that gets only number of all Solr files indexed without actually returning the files. The result does not include chunks, only number of actual files.

Returns
int representing number of indexed files
Exceptions
KeywordSearchModuleException
NoOpenCoreExceptionn

Definition at line 676 of file Server.java.

Referenced by org.sleuthkit.autopsy.keywordsearch.SearchRunner.commit(), org.sleuthkit.autopsy.keywordsearch.DropdownToolbar.KeywordPropertyChangeListener.propertyChange(), and org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.shutDown().

TermsResponse org.sleuthkit.autopsy.keywordsearch.Server.queryTerms ( SolrQuery  sq) throws KeywordSearchModuleException, NoOpenCoreException

Execute Solr terms query

Parameters
sqthe query
Returns
terms response
Exceptions
KeywordSearchModuleException
NoOpenCoreException

Definition at line 820 of file Server.java.

void org.sleuthkit.autopsy.keywordsearch.Server.validateIndexLocation ( Case  theCase)
private

Checks if index dir exists, and moves it to new location if needed (for backwards compatibility with older cases)

Definition at line 585 of file Server.java.

References org::sleuthkit::datamodel::AbstractFile.exists(), org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory(), and org::sleuthkit::datamodel::AbstractContent.getParent().

Member Data Documentation

final String org.sleuthkit.autopsy.keywordsearch.Server.CORE_EVT = "CORE_EVT"
static
volatile Core org.sleuthkit.autopsy.keywordsearch.Server.currentCore = null
private

** Convenience methods for use while we only open one case at a time ***

Definition at line 565 of file Server.java.

int org.sleuthkit.autopsy.keywordsearch.Server.currentSolrServerPort = 0
private

Definition at line 164 of file Server.java.

int org.sleuthkit.autopsy.keywordsearch.Server.currentSolrStopPort = 0
private

Definition at line 165 of file Server.java.

Process org.sleuthkit.autopsy.keywordsearch.Server.curSolrProcess = null
private

Definition at line 156 of file Server.java.

final boolean org.sleuthkit.autopsy.keywordsearch.Server.DEBUG = false
staticprivate

Definition at line 166 of file Server.java.

final String org.sleuthkit.autopsy.keywordsearch.Server.DEFAULT_CORE_NAME = "coreCase"
staticprivate

Definition at line 149 of file Server.java.

final Charset org.sleuthkit.autopsy.keywordsearch.Server.DEFAULT_INDEXED_TEXT_CHARSET = Charset.forName("UTF-8")
static

default Charset to index text as

Definition at line 154 of file Server.java.

InputStreamPrinterThread org.sleuthkit.autopsy.keywordsearch.Server.errorRedirectThread
private

Definition at line 176 of file Server.java.

final String org.sleuthkit.autopsy.keywordsearch.Server.HL_ANALYZE_CHARS_UNLIMITED = "500000"
static

Definition at line 145 of file Server.java.

final char org.sleuthkit.autopsy.keywordsearch.Server.ID_CHUNK_SEP = '_'
static
Ingester org.sleuthkit.autopsy.keywordsearch.Server.ingester = null
staticprivate

Definition at line 157 of file Server.java.

String org.sleuthkit.autopsy.keywordsearch.Server.instanceDir
private

Definition at line 173 of file Server.java.

String org.sleuthkit.autopsy.keywordsearch.Server.javaPath = "java"
private

Definition at line 153 of file Server.java.

final String org.sleuthkit.autopsy.keywordsearch.Server.KEY = "jjk#09s"
staticprivate

Definition at line 161 of file Server.java.

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

Definition at line 148 of file Server.java.

final long org.sleuthkit.autopsy.keywordsearch.Server.MAX_CONTENT_SIZE = 1L * 1024 * 1024 * 1024
static

Definition at line 147 of file Server.java.

final int org.sleuthkit.autopsy.keywordsearch.Server.MAX_SOLR_MEM_MB = 512
staticprivate

Definition at line 155 of file Server.java.

ServerAction org.sleuthkit.autopsy.keywordsearch.Server.serverAction
private

Definition at line 175 of file Server.java.

File org.sleuthkit.autopsy.keywordsearch.Server.solrFolder
private

Definition at line 174 of file Server.java.

SolrServer org.sleuthkit.autopsy.keywordsearch.Server.solrServer
private

Definition at line 171 of file Server.java.

String org.sleuthkit.autopsy.keywordsearch.Server.solrUrl
private

Definition at line 177 of file Server.java.


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

Copyright © 2012-2015 Basis Technology. Generated on: Mon Oct 19 2015
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.