org.sleuthkit.autopsy.datamodel.ContentUtils Class Reference

Classes
class	ExtractFscContentVisitor
class	SystemNameVisitor

Static Public Member Functions
static String	getStringTime (long epochSeconds, TimeZone tzone)
static String	getStringTime (long epochSeconds, Content content)
static String	getStringTimeISO8601 (long epochSeconds, TimeZone tzone)
static String	getStringTimeISO8601 (long epochSeconds, Content c)
static String	getSystemName (Content content)
static TimeZone	getTimeZone (Content content)
static boolean	isDotDirectory (AbstractFile dir)
static boolean	shouldDisplayTimesInLocalTime ()
static< T > long	writeToFile (Content content, java.io.File outputFile, ProgressHandle progress, Future< T > worker, boolean source) throws IOException
static void	writeToFile (Content content, java.io.File outputFile) throws IOException
static long	writeToFile (Content content, java.io.File outputFile, Supplier< Boolean > cancelCheck) throws IOException
static long	writeToFile (Content content, java.io.File outputFile, Supplier< Boolean > cancelCheck, long startingOffset, long endingOffset) throws IOException

Private Member Functions
	ContentUtils ()

Static Private Attributes
static final SimpleDateFormat	dateFormatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss z")
static final SimpleDateFormat	dateFormatterISO8601 = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'")
static boolean	displayTimesInLocalTime = UserPreferences.displayTimesInLocalTime()
static final Logger	logger = Logger.getLogger(ContentUtils.class.getName())
static final SystemNameVisitor	systemName = new SystemNameVisitor()
static final int	TO_FILE_BUFFER_SIZE = 8192

Detailed Description

Static class of utility methods for Content objects

Definition at line 55 of file ContentUtils.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.datamodel.ContentUtils.ContentUtils ( )

private

Don't instantiate

Definition at line 76 of file ContentUtils.java.

Member Function Documentation

static String org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime ( long  epochSeconds, TimeZone  tzone  )

static

Convert epoch seconds to a string value in the given time zone.

Parameters

epochSeconds	Epoch seconds
tzone	Time zone

Returns

The time

Definition at line 88 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.dateFormatter.

Referenced by org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.addEmailMsgProperty(), org.sleuthkit.autopsy.datamodel.KeywordHits.createBlackboardArtifactNode(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.createSheet(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.fillPropertyMap(), org.sleuthkit.autopsy.datamodel.BlackboardArtifactNode.fillPropertyMap(), org.sleuthkit.autopsy.report.infrastructure.TableReportGenerator.AttributeColumn.getCellData(), org.sleuthkit.autopsy.datamodel.AbstractAbstractFileNode< SpecialDirectory >.getProperties(), org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime(), and org.sleuthkit.autopsy.contentviewers.Metadata.setNode().

static String org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime ( long  epochSeconds, Content  content  )

static

Convert epoch seconds to a string value (convenience method)

Parameters

epochSeconds
content

Returns

Definition at line 127 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime(), and org.sleuthkit.autopsy.datamodel.ContentUtils.getTimeZone().

static String org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTimeISO8601 ( long  epochSeconds, TimeZone  tzone  )

static

Convert epoch seconds to a string value (ISO8601) in the given time zone.

Parameters

epochSeconds	Epoch seconds
tzone	Time zone

Returns

The time

Definition at line 107 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.dateFormatterISO8601.

Referenced by org.sleuthkit.autopsy.keywordsearch.Ingester.SolrFieldsVisitor.getCommonAndMACTimeFields(), and org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTimeISO8601().

static String org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTimeISO8601 ( long  epochSeconds, Content  c  )

static

Convert epoch seconds to a string value (convenience method) in ISO8601 format such as 2008-07-04T13:45:04Z

Parameters

epochSeconds
c

Returns

Definition at line 140 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTimeISO8601(), and org.sleuthkit.autopsy.datamodel.ContentUtils.getTimeZone().

static String org.sleuthkit.autopsy.datamodel.ContentUtils.getSystemName ( Content  content )

static

Get system name from content using SystemNameVisitor.

Parameters

content

The content object.

Returns

The system name.

Definition at line 172 of file ContentUtils.java.

static TimeZone org.sleuthkit.autopsy.datamodel.ContentUtils.getTimeZone ( Content  content )

static

Definition at line 144 of file ContentUtils.java.

References org.sleuthkit.autopsy.core.UserPreferences.getTimeZoneForDisplays(), and org.sleuthkit.autopsy.datamodel.ContentUtils.shouldDisplayTimesInLocalTime().

Referenced by org.sleuthkit.autopsy.contentviewers.artifactviewers.DefaultArtifactContentViewer.ResultsTableArtifact.epochTimeToString(), org.sleuthkit.autopsy.datamodel.ArtifactStringContent.getString(), org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime(), and org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTimeISO8601().

static boolean org.sleuthkit.autopsy.datamodel.ContentUtils.isDotDirectory ( AbstractFile  dir )

static

Helper to ignore the '.' and '..' directories

Parameters

dir	the directory to check

Returns

true if dir is a '.' or '..' directory, false otherwise

Definition at line 356 of file ContentUtils.java.

Referenced by org.sleuthkit.autopsy.directorytree.actionhelpers.ExtractActionHelper.runExtractionTasks(), org.sleuthkit.autopsy.modules.hashdatabase.HashDbSearchAction.InitializeContentVisitor.visit(), and org.sleuthkit.autopsy.datamodel.ContentUtils.ExtractFscContentVisitor< T, V >.visitDir().

static boolean org.sleuthkit.autopsy.datamodel.ContentUtils.shouldDisplayTimesInLocalTime ( )

static

Indicates whether or not times should be displayed using local time.

Returns

True or false.

Definition at line 557 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.displayTimesInLocalTime.

Referenced by org.sleuthkit.autopsy.datamodel.ContentUtils.getTimeZone().

static <T> long org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile ( Content  content, java.io.File  outputFile, ProgressHandle  progress, Future< T >  worker, boolean  source  ) throws IOException

static

Reads all the data from any content object and writes (extracts) it to a file.

Parameters

content	Any content object.
outputFile	Will be created if it doesn't exist, and overwritten if it does
progress	progress bar handle to update, if available. null otherwise
worker	the swing worker background thread the process runs within, or null, if in the main thread, used to handle task cancellation
source	true if source file

Returns

number of bytes extracted

Exceptions

IOException

if file could not be written

Definition at line 210 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.TO_FILE_BUFFER_SIZE.

Referenced by org.sleuthkit.autopsy.directorytree.ExternalViewerAction.actionPerformed(), org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.copyContent(), org.sleuthkit.autopsy.coreutils.SQLiteTableReader.copyFileToTempDirectory(), org.sleuthkit.autopsy.corecomponents.DataContentViewerHex.BackgroundFileCopyTask.doInBackground(), org.sleuthkit.autopsy.contentviewers.MediaPlayerPanel.ExtractMedia.doInBackground(), org.sleuthkit.autopsy.coreutils.AppSQLiteDB.findAndCopySQLiteDB(), org.sleuthkit.autopsy.coreutils.AppSQLiteDB.findAndCopySQLiteMetaFile(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processMBox(), org.sleuthkit.autopsy.thunderbirdparser.ThunderbirdMboxFileIngestModule.processPst(), org.sleuthkit.autopsy.datamodel.ContentUtils.ExtractFscContentVisitor< T, V >.visit(), and org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile().

static void org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile ( Content  content, java.io.File  outputFile  ) throws IOException

static

Write content to an output file.

Parameters

content	The Content object.
outputFile	The output file.

Exceptions

IOException

If the file could not be written.

Definition at line 253 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile().

static long org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile ( Content  content, java.io.File  outputFile, Supplier< Boolean >  cancelCheck  ) throws IOException

static

Reads all the data from any content object and writes (extracts) it to a file, using a cancellation check instead of a Future object method.

Parameters

content	Any content object.
outputFile	Will be created if it doesn't exist, and overwritten if it does
cancelCheck	A function used to check if the file write process should be terminated.

Returns

number of bytes extracted

Exceptions

IOException

if file could not be written

Definition at line 271 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.TO_FILE_BUFFER_SIZE.

static long org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile ( Content  content, java.io.File  outputFile, Supplier< Boolean >  cancelCheck, long  startingOffset, long  endingOffset  ) throws IOException

static

Reads all the data from any content object and writes (extracts) it to a file, using a cancellation check instead of a Future object method.

Parameters

content	Any content object.
outputFile	Will be created if it doesn't exist, and overwritten if it does
cancelCheck	A function used to check if the file write process should be terminated.
startingOffset	the starting offset to start reading the file
endingOffset	the ending offset to read of the file to write

Returns

number of bytes extracted

Exceptions

IOException

if file could not be written

Definition at line 309 of file ContentUtils.java.

References org.sleuthkit.autopsy.datamodel.ContentUtils.TO_FILE_BUFFER_SIZE.

Member Data Documentation

final SimpleDateFormat org.sleuthkit.autopsy.datamodel.ContentUtils.dateFormatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss z")

staticprivate

Definition at line 59 of file ContentUtils.java.

Referenced by org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTime().

final SimpleDateFormat org.sleuthkit.autopsy.datamodel.ContentUtils.dateFormatterISO8601 = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'")

staticprivate

Definition at line 60 of file ContentUtils.java.

Referenced by org.sleuthkit.autopsy.datamodel.ContentUtils.getStringTimeISO8601().

boolean org.sleuthkit.autopsy.datamodel.ContentUtils.displayTimesInLocalTime = UserPreferences.displayTimesInLocalTime()

staticprivate

Definition at line 58 of file ContentUtils.java.

Referenced by org.sleuthkit.autopsy.datamodel.ContentUtils.shouldDisplayTimesInLocalTime().

final Logger org.sleuthkit.autopsy.datamodel.ContentUtils.logger = Logger.getLogger(ContentUtils.class.getName())

staticprivate

Definition at line 57 of file ContentUtils.java.

final SystemNameVisitor org.sleuthkit.autopsy.datamodel.ContentUtils.systemName = new SystemNameVisitor()

staticprivate

Definition at line 163 of file ContentUtils.java.

final int org.sleuthkit.autopsy.datamodel.ContentUtils.TO_FILE_BUFFER_SIZE = 8192

staticprivate

Definition at line 190 of file ContentUtils.java.

Referenced by org.sleuthkit.autopsy.datamodel.ContentUtils.writeToFile().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/datamodel/ContentUtils.java