Provides singleton access to many framework services. More...

#include <TskServices.h>

Public Member Functions
TskBlackboard &	getBlackboard ()
	Return the blackboard service. More...

TskFileManager &	getFileManager ()
	Return the File Manager service. More...

TskImageFile &	getImageFile ()
	Return the image file service. More...

TskImgDB &	getImgDB ()
	Return the database service. More...

Log &	getLog ()
	Return the system log service. More...

Scheduler &	getScheduler ()
	Return the system scheduler service. More...

TskSystemProperties &	getSystemProperties ()
	Return the system properties service. More...

void	setBlackboard (TskBlackboard &blackboard)
	Set the blackboard service. More...

void	setFileManager (TskFileManager &fileManager)
	Set the File Manager service. More...

void	setImageFile (TskImageFile &imgFile)
	Set the image file service. More...

void	setImgDB (TskImgDB &imgDB)
	Set the database service. More...

void	setLog (Log &log)
	Set the log service. More...

void	setScheduler (Scheduler &scheduler)
	Set the scheduler service. More...

void	setSystemProperties (TskSystemProperties &systemProperties)
	Set the system properties service. More...

Static Public Member Functions
static TskServices &	Instance ()
	Singleton interface to return the TskServices instance.

Detailed Description

Provides singleton access to many framework services.

This is used to register and access the classes that implement the services.

Member Function Documentation

TskBlackboard & TskServices::getBlackboard ( )

Return the blackboard service.

If no service was setup, an exception is thrown.

Returns: blackboard file reference.

References LOGERROR.

Referenced by TskFile::createArtifact(), TskFile::getAllArtifacts(), TskFile::getArtifacts(), and TskBlackboardAttribute::getParentArtifact().

TskFileManager & TskServices::getFileManager ( )

Return the File Manager service.

Returns: File Manager reference.

Exceptions

TskException if File Manager has not been set.

References LOGERROR.

Referenced by TskFile::save().

TskImageFile & TskServices::getImageFile ( )

Return the image file service.

If no service was setup, an exception is thrown.

Returns: image file reference.

References LOGERROR.

Referenced by TskFileTsk::close(), SectorRuns::getData(), TskFileTsk::open(), and TskFileTsk::read().

TskImgDB & TskServices::getImgDB ( )

Return the database service.

If no service was setup, an exception is thrown.

Returns: database reference.

References LOGERROR.

Referenced by TskFileManagerImpl::copyDirectory(), TskFileManagerImpl::findFilesByExtension(), TskFileManagerImpl::findFilesByFsFileType(), TskFileManagerImpl::findFilesByName(), TskFileManagerImpl::findFilesByParent(), TskFileManagerImpl::findFilesByPattern(), TskSystemProperties::get(), TskFile::getKnownStatus(), TskFile::getUniquePath(), TskPipeline::initialize(), TskFile::initialize(), TskCarvePrepSectorConcat::onUnallocSectorsImgFileCreated(), TskCarveExtractScalpel::processFile(), TskCarvePrepSectorConcat::processFiles(), TskFileAnalysisPipeline::run(), TskReportPipeline::run(), and TskFile::setStatus().

Log & TskServices::getLog ( )

Return the system log service.

If no log was setup, a service will be created that sends messages to stderr.

Returns: log reference.

References Log::logInfo().

Referenced by SectorRuns::addRun().

Scheduler & TskServices::getScheduler ( )

Return the system scheduler service.

If no service was setup, an exception is thrown.

Returns: scheduler reference.

References LOGERROR.

TskSystemProperties & TskServices::getSystemProperties ( )

Return the system properties service.

If no service was setup, a default memory-based version is created.

Returns: system properties reference.

References TskSystemPropertiesImpl::initialize(), LOGINFO, and setSystemProperties().

void TskServices::setBlackboard ( TskBlackboard & blackboard)

Set the blackboard service.

Throws an exception if one has already been set.

References LOGERROR.

void TskServices::setFileManager ( TskFileManager & fileManager)

Set the File Manager service.

The standard framework implementation class is TskFileManagerImpl.

Parameters

fileManager A File Manager implementation.

Exceptions

TskException if one has already been set.

References LOGERROR.

void TskServices::setImageFile ( TskImageFile & imageFile)

Set the image file service.

Throws an exception if one has already been set.

References LOGERROR.

void TskServices::setImgDB ( TskImgDB & imgDB)

Set the database service.

Throws an exception if one has already been set.

References LOGERROR.

void TskServices::setLog ( Log & log)

Set the log service.

Throws an exception if one has already been set.

References LOGERROR.

void TskServices::setScheduler ( Scheduler & scheduler)

Set the scheduler service.

Throws an exception if one has already been set.

References LOGERROR.

void TskServices::setSystemProperties ( TskSystemProperties & systemProperties)

Set the system properties service.

Throws an exception if one has already been set.

References LOGERROR.

Referenced by getSystemProperties().

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

framework/tsk/framework/services/TskServices.h
framework/tsk/framework/services/TskServices.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation