TskFileAnalysisPipeline Class Reference

Controls the processing of a file analysis pipeline. More...

#include <TskFileAnalysisPipeline.h>

Inheritance diagram for TskFileAnalysisPipeline:

Public Member Functions
TskPluginModule *	createPluginModule ()
	Create a module for the given pipeline type. More...
virtual void	run (const uint64_t fileId)
	Run a file analysis pipeline on a file with the given ID. More...
virtual void	run (TskFile *file)
	Run a file analysis pipeline on the given file object. More...
virtual void	run ()
	Run a reporting / post-analysis pipeline. More...
Public Member Functions inherited from TskPipeline
void	initialize (const std::string &pipelineConfig)
	Parses the XML config file. More...
bool	isEmpty () const
void	logModuleExecutionTimes () const
	Logs the recorded execution times of the modules in the pipeline.
	TskPipeline ()
	Default constructor.
void	validate (const std::string &pipelineConfig)
	Validate a Pipeline based on the given XML configuration string. More...
	~TskPipeline ()
	Destructor.

Additional Inherited Members
Static Public Attributes inherited from TskPipeline
static const std::string	MODULE_ARGS_ATTR = "arguments"
	attribute for module arguments in XML config file
static const std::string	MODULE_ELEMENT = "MODULE"
	module element in XML config file
static const std::string	MODULE_EXECUTABLE_TYPE = "executable"
	value of MODULE_TYPE_ATTR for executable modules
static const std::string	MODULE_LOCATION_ATTR = "location"
	attribute for module location in XML config file
static const std::string	MODULE_ORDER_ATTR = "order"
	attribute for module order in XML config file
static const std::string	MODULE_OUTPUT_ATTR = "output"
	attribute for module output in XML config file
static const std::string	MODULE_PLUGIN_TYPE = "plugin"
	value of MODULE_TYPE_ATTR for library modules
static const std::string	MODULE_TYPE_ATTR = "type"
	attribute for module type in XML config file
Protected Member Functions inherited from TskPipeline
bool	excludeFile (const TskFile *)
	Determine whether a particular file should be processed. More...
void	updateModuleExecutionTime (int moduleId, const Poco::Timespan::TimeDiff &executionTime)
	Updates the recorded execution time of a module in the pipeline. More...
Protected Attributes inherited from TskPipeline
bool	m_hasExeModule
	True if any module is an executable module.
std::vector< TskModule * >	m_modules
	Collection of modules in the pipeline.

Detailed Description

Controls the processing of a file analysis pipeline.

Member Function Documentation

TskPluginModule* TskFileAnalysisPipeline::createPluginModule ( )

inlinevirtual

Create a module for the given pipeline type.

Returns

Plug-in module

Implements TskPipeline.

void TskFileAnalysisPipeline::run ( const uint64_t  fileId)

virtual

Run a file analysis pipeline on a file with the given ID.

Parameters

fileId

Id of file to run pipeilne on.

Exceptions

exceptions

on errors

Implements TskPipeline.

References TskPipeline::m_modules, and run().

void TskFileAnalysisPipeline::run ( TskFile *  file)

virtual

Run a file analysis pipeline on the given file object.

Parameters

file	TskFile object to run pipeilne on.

Exceptions

exceptions

on errors

Implements TskPipeline.

References TskFileManagerImpl::deleteFile(), TskPipeline::excludeFile(), TskFile::exists(), TskModule::FAIL, TskFile::getId(), TskServices::getImgDB(), TskFile::getName(), TskFile::getStatus(), TskFile::getTypeId(), TskServices::Instance(), LOGERROR, LOGINFO, TskPipeline::m_hasExeModule, TskPipeline::m_modules, TskFile::open(), TskFileManagerImpl::saveFile(), TskFile::seek(), TskFile::setStatus(), TskModule::STOP, TskImgDB::updateFileStatus(), and TskPipeline::updateModuleExecutionTime().

virtual void TskFileAnalysisPipeline::run ( )

inlinevirtual

Run a reporting / post-analysis pipeline.

Exceptions

exceptions

on errors

Implements TskPipeline.

Referenced by run().

---

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

• framework/tsk/framework/pipeline/TskFileAnalysisPipeline.h
• framework/tsk/framework/pipeline/TskFileAnalysisPipeline.cpp