TskPipelineManager Class Reference

Responsible for creation and destruction of of TskPipeline objects. More...

#include <TskPipelineManager.h>

Public Types
enum	PIPELINE_TYPE { FILE_ANALYSIS_PIPELINE, POST_PROCESSING_PIPELINE }
	Supported pipeline types. More...

Public Member Functions
TskPipeline *	createPipeline (const std::string &pipelineType)
	Creates a pipeline object by reading the pipeline config file specified as a system property. More...
TskPipeline *	createPipeline (const PIPELINE_TYPE type, const std::string &name="")
	Create a pipeline of the given type and optionally a given name. More...

Static Public Attributes
static const std::string	FILE_ANALYSIS_PIPELINE_STR = "FileAnalysis"
	String to use in pipeline configuration file when creating a file analysis pipeline.
static const std::string	PIPELINE_ELEMENT = "PIPELINE"
	String to use in pipeline configuration file when creating a pipeline element.
static const std::string	PIPELINE_NAME_ATTRIBUTE = "name"
	Attribute in PIPELINE_ELEMENT for optional pipeline name in config XML file.
static const std::string	PIPELINE_TYPE_ATTRIBUTE = "type"
	Attribute in PIPELINE_ELEMENT for pipeline type in config XML file.
static const std::string	POST_PROCESSING_PIPELINE_STR = "PostProcessing"
	String to use in pipeline configuration file when creating a post processing pipeline.
static const std::string	REPORTING_PIPELINE_STR = "Report"
	Deprecated: String to use in pipeline configuration file when creating a post processing pipeline.

Detailed Description

Responsible for creation and destruction of of TskPipeline objects.

This class is responsible for reading the pipeline configuration file.

Member Enumeration Documentation

enum TskPipelineManager::PIPELINE_TYPE

Supported pipeline types.

Enumerator
FILE_ANALYSIS_PIPELINE	A pipeline that operates on every file in the system.
POST_PROCESSING_PIPELINE	A pipeline that is run once file analysis is complete.

Member Function Documentation

TskPipeline * TskPipelineManager::createPipeline

(

const std::string &

pipelineType)

Creates a pipeline object by reading the pipeline config file specified as a system property.

Returns

Pointer to TskPipeline. Do not free this. It will be freed by the TskPipelineManager destructor.

References FILE_ANALYSIS_PIPELINE, FILE_ANALYSIS_PIPELINE_STR, POST_PROCESSING_PIPELINE, POST_PROCESSING_PIPELINE_STR, and REPORTING_PIPELINE_STR.

TskPipeline * TskPipelineManager::createPipeline	(	const PIPELINE_TYPE	type,
		const std::string &	name = ""
	)

Create a pipeline of the given type and optionally a given name.

Parameters

type	The type of pipeline to create
name	An optional string to disambiguate the situation where there are multiple pipelines of the same type.

Returns

Pointer to a pipeline object. This pointer is managed by TskPipelineManager which will free it in its desctructor.

References FILE_ANALYSIS_PIPELINE, TskPipeline::initialize(), LOGINFO, TskSystemProperties::PIPELINE_CONFIG_FILE, PIPELINE_ELEMENT, PIPELINE_NAME_ATTRIBUTE, PIPELINE_TYPE_ATTRIBUTE, POST_PROCESSING_PIPELINE, POST_PROCESSING_PIPELINE_STR, and REPORTING_PIPELINE_STR.

---

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

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