Inherits org.sleuthkit.datamodel.AbstractContent.

Inherited by org.sleuthkit.datamodel.DerivedFile, org.sleuthkit.datamodel.FsContent, org.sleuthkit.datamodel.LayoutFile, org.sleuthkit.datamodel.LocalFile, and org.sleuthkit.datamodel.SpecialDirectory.

Classes
enum	MimeMatchEnum

Public Member Functions
boolean	canRead ()

void	close ()

long	convertToImgOffset (long fileOffset) throws TskCoreException

boolean	exists ()

long	getAtime ()

String	getAtimeAsDate ()

int	getAttributeId ()

short	getAttrId ()

TskData.TSK_FS_ATTR_TYPE_ENUM	getAttrType ()

long	getCrtime ()

String	getCrtimeAsDate ()

long	getCtime ()

String	getCtimeAsDate ()

Content	getDataSource () throws TskCoreException

String	getDirFlagAsString ()

TSK_FS_NAME_TYPE_ENUM	getDirType ()

String	getDirTypeAsString ()

int	getGid ()

TskData.FileKnown	getKnown ()

String	getLocalAbsPath ()

String	getLocalPath ()

String	getMd5Hash ()

long	getMetaAddr ()

String	getMetaFlagsAsString ()

long	getMetaSeq ()

TSK_FS_META_TYPE_ENUM	getMetaType ()

String	getMetaTypeAsString ()

String	getMIMEType ()

String	getModesAsString ()

long	getMtime ()

String	getMtimeAsDate ()

String	getNameExtension ()

String	getParentPath ()

List< TskFileRange >	getRanges () throws TskCoreException

long	getSize ()

TskData.TSK_DB_FILES_TYPE_ENUM	getType ()

int	getUid ()

boolean	isDir ()

boolean	isDirNameFlagSet (TSK_FS_NAME_FLAG_ENUM flag)

boolean	isFile ()

boolean	isMetaFlagSet (TSK_FS_META_FLAG_ENUM metaFlag)

MimeMatchEnum	isMimeType (SortedSet< String > mimeTypes)

boolean	isModeSet (TskData.TSK_FS_META_MODE_ENUM mode)

abstract boolean	isRoot ()

boolean	isVirtual ()

List< AbstractFile >	listFiles () throws TskCoreException

final int	read (byte[] buf, long offset, long len) throws TskCoreException

void	save () throws TskCoreException

void	setKnown (TskData.FileKnown knownState)

void	setMd5Hash (String md5Hash)

void	setMIMEType (String mimeType)

String	toString (boolean preserveState)

Public Member Functions inherited from org.sleuthkit.datamodel.AbstractContent
boolean	equals (Object obj)

ArrayList< BlackboardArtifact >	getAllArtifacts () throws TskCoreException

long	getAllArtifactsCount () throws TskCoreException

ArrayList< BlackboardArtifact >	getArtifacts (String artifactTypeName) throws TskCoreException

ArrayList< BlackboardArtifact >	getArtifacts (int artifactTypeID) throws TskCoreException

ArrayList< BlackboardArtifact >	getArtifacts (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException

long	getArtifactsCount (String artifactTypeName) throws TskCoreException

long	getArtifactsCount (int artifactTypeID) throws TskCoreException

long	getArtifactsCount (ARTIFACT_TYPE type) throws TskCoreException

List< Content >	getChildren () throws TskCoreException

int	getChildrenCount () throws TskCoreException

List< Long >	getChildrenIds () throws TskCoreException

Content	getDataSource () throws TskCoreException

BlackboardArtifact	getGenInfoArtifact () throws TskCoreException

BlackboardArtifact	getGenInfoArtifact (boolean create) throws TskCoreException

ArrayList< BlackboardAttribute >	getGenInfoAttributes (ATTRIBUTE_TYPE attr_type) throws TskCoreException

Set< String >	getHashSetNames () throws TskCoreException

long	getId ()

String	getName ()

synchronized Content	getParent () throws TskCoreException

SleuthkitCase	getSleuthkitCase ()

synchronized String	getUniquePath () throws TskCoreException

boolean	hasChildren () throws TskCoreException

int	hashCode ()

BlackboardArtifact	newArtifact (int artifactTypeID) throws TskCoreException

BlackboardArtifact	newArtifact (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException

String	toString ()

String	toString (boolean preserveState)

Public Member Functions inherited from org.sleuthkit.datamodel.Content
public< T > T	accept (ContentVisitor< T > v)

long	getArtifactsCount (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException

ArrayList< BlackboardAttribute >	getGenInfoAttributes (BlackboardAttribute.ATTRIBUTE_TYPE attr_type) throws TskCoreException

Public Member Functions inherited from org.sleuthkit.datamodel.SleuthkitVisitableItem
public< T > T	accept (SleuthkitItemVisitor< T > v)

Static Public Member Functions
static String	createNonUniquePath (String uniquePath)

static String	epochToTime (long epoch)

static String	epochToTime (long epoch, TimeZone tzone)

static long	timeToEpoch (String time)

Protected Member Functions
	AbstractFile (SleuthkitCase db, long objId, TskData.TSK_FS_ATTR_TYPE_ENUM attrType, short attrId, String name, TskData.TSK_DB_FILES_TYPE_ENUM fileType, long metaAddr, int metaSeq, TSK_FS_NAME_TYPE_ENUM dirType, TSK_FS_META_TYPE_ENUM metaType, TSK_FS_NAME_FLAG_ENUM dirFlag, short metaFlags, long size, long ctime, long crtime, long atime, long mtime, short modes, int uid, int gid, String md5Hash, FileKnown knownState, String parentPath)

void	finalize () throws Throwable

int	readInt (byte[] buf, long offset, long len) throws TskCoreException

final int	readLocal (byte[] buf, long offset, long len) throws TskCoreException

void	setLocalPath (String localPath, boolean isAbsolute)

Protected Member Functions inherited from org.sleuthkit.datamodel.AbstractContent
	AbstractContent (SleuthkitCase db, long obj_id, String name)

Protected Attributes
final int	attrId

final TskData.TSK_FS_ATTR_TYPE_ENUM	attrType

final TSK_FS_NAME_FLAG_ENUM	dirFlag

final TSK_FS_NAME_TYPE_ENUM	dirType

final TskData.TSK_DB_FILES_TYPE_ENUM	fileType

TskData.FileKnown	knownState

String	md5Hash

final long	metaAddr

final Set< TSK_FS_META_FLAG_ENUM >	metaFlags

final int	metaSeq

final TSK_FS_META_TYPE_ENUM	metaType

final Set< TskData.TSK_FS_META_MODE_ENUM >	modes

final String	parentPath

long	size

final int	uid

Protected Attributes inherited from org.sleuthkit.datamodel.AbstractContent
long	parentId

Private Member Functions
void	loadLocalFile () throws TskCoreException

Private Attributes
long	dataSourceObjectId

TskData.EncodingType	encodingType

final String	extension

boolean	knownStateDirty = false

String	localAbsPath
	absolute path representation of the local path More...

volatile java.io.File	localFile

volatile RandomAccessFile	localFileHandle

String	localPath
	local path as stored in db tsk_files_path, is relative to the db, More...

boolean	localPathSet = false
	if set by setLocalPath(), reads are done on local file More...

boolean	md5HashDirty = false

String	mimeType

boolean	mimeTypeDirty = false

List< TskFileRange >	ranges

Static Private Attributes
static final ResourceBundle	BUNDLE = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")

static final Logger	LOGGER = Logger.getLogger(AbstractFile.class.getName())

Additional Inherited Members
Static Public Attributes inherited from org.sleuthkit.datamodel.AbstractContent
static final long	UNKNOWN_ID = -1

Detailed Description

An abstract base class for classes that represent files that have been added to the case.

Definition at line 46 of file AbstractFile.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.AbstractFile.AbstractFile	(	SleuthkitCase	db,
		long	objId,
		TskData.TSK_FS_ATTR_TYPE_ENUM	attrType,
		short	attrId,
		String	name,
		TskData.TSK_DB_FILES_TYPE_ENUM	fileType,
		long	metaAddr,
		int	metaSeq,
		TSK_FS_NAME_TYPE_ENUM	dirType,
		TSK_FS_META_TYPE_ENUM	metaType,
		TSK_FS_NAME_FLAG_ENUM	dirFlag,
		short	metaFlags,
		long	size,
		long	ctime,
		long	crtime,
		long	atime,
		long	mtime,
		short	modes,
		int	uid,
		int	gid,
		String	md5Hash,
		FileKnown	knownState,
		String	parentPath
	)

protected

Initializes common fields used by AbstactFile implementations (objects in tsk_files table)

Parameters

db	case / db handle where this file belongs to
objId	object id in tsk_objects table
attrType
attrId
name	name field of the file
fileType	type of the file
metaAddr
metaSeq
dirType
metaType
dirFlag
metaFlags
size
ctime
crtime
atime
mtime
modes
uid
gid
md5Hash	md5sum of the file, or null or "NULL" if not present
knownState	knownState status of the file, or null if unknown (default)
parentPath

Deprecated:: Do not make subclasses outside of this package.

Definition at line 1154 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.attrType, org.sleuthkit.datamodel.AbstractContent.db, and org.sleuthkit.datamodel.AbstractContent.objId.

Member Function Documentation

boolean org.sleuthkit.datamodel.AbstractFile.canRead ( )

Check if the file exists and is readable. If non-local (e.g. within an image), always true, if local, checks if actual local path exists and is readable

Returns: true if the file is readable

Definition at line 953 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.canRead(), org.sleuthkit.datamodel.AbstractFile.loadLocalFile(), and org.sleuthkit.datamodel.AbstractFile.localFile.

Referenced by org.sleuthkit.datamodel.AbstractFile.canRead(), and org.sleuthkit.datamodel.AbstractFile.readLocal().

void org.sleuthkit.datamodel.AbstractFile.close ( )

Free native resources after read is done on the Content object. After closing, read can be called again on the same Content object, which should result in re-opening of new native resources.

Implements org.sleuthkit.datamodel.Content.

Definition at line 992 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractContent.getName(), and org.sleuthkit.datamodel.AbstractFile.getParentPath().

Referenced by org.sleuthkit.datamodel.DerivedFile.finalize(), and org.sleuthkit.datamodel.AbstractFile.finalize().

long org.sleuthkit.datamodel.AbstractFile.convertToImgOffset ( long fileOffset ) throws TskCoreException

Convert an internal offset to an image offset

Parameters

fileOffset the byte offset in this layout file to map

Returns: the corresponding byte offset in the image where the file offset is located, or -1 if the file has no range layout information or if the fileOffset is larger than file size

Exceptions

TskCoreException exception thrown if critical error occurred within tsk core and offset could not be converted

Definition at line 580 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.getRanges().

static String org.sleuthkit.datamodel.AbstractFile.createNonUniquePath ( String uniquePath )

static

Parameters

uniquePath the unique path to an AbstractFile (or subclass) usually obtained by a call to AbstractFile.getUniquePath.

Returns: the path to to an AbstractFile (or subclass) with the image and volume path segments removed.

Definition at line 651 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.SleuthkitCase.openFiles().

static String org.sleuthkit.datamodel.AbstractFile.epochToTime ( long epoch )

static

Return the epoch into string in ISO 8601 dateTime format

Parameters

epoch time in seconds

Returns: formatted date time string as "yyyy-MM-dd HH:mm:ss"

Deprecated:

Definition at line 1261 of file AbstractFile.java.

References org.sleuthkit.datamodel.TimeUtilities.epochToTime().

Referenced by org.sleuthkit.datamodel.AbstractFile.getAtimeAsDate(), org.sleuthkit.datamodel.AbstractFile.getCrtimeAsDate(), org.sleuthkit.datamodel.AbstractFile.getCtimeAsDate(), and org.sleuthkit.datamodel.AbstractFile.getMtimeAsDate().

static String org.sleuthkit.datamodel.AbstractFile.epochToTime	(	long	epoch,
		TimeZone	tzone
	)

static

Return the epoch into string in ISO 8601 dateTime format, in the given timezone

Parameters

epoch	time in seconds
tzone	time zone

Returns: formatted date time string as "yyyy-MM-dd HH:mm:ss"

Deprecated:

Definition at line 1277 of file AbstractFile.java.

References org.sleuthkit.datamodel.TimeUtilities.epochToTime().

boolean org.sleuthkit.datamodel.AbstractFile.exists ( )

Check if the file exists. If non-local always true, if local, checks if actual local path exists

Returns: true if the file exists, false otherwise

Definition at line 932 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.exists(), org.sleuthkit.datamodel.AbstractFile.loadLocalFile(), and org.sleuthkit.datamodel.AbstractFile.localFile.

Referenced by org.sleuthkit.datamodel.AbstractFile.exists(), org.sleuthkit.datamodel.Image.imageFileExists(), and org.sleuthkit.datamodel.AbstractFile.readLocal().

void org.sleuthkit.datamodel.AbstractFile.finalize ( ) throws Throwable

protected

Definition at line 1011 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.close().

long org.sleuthkit.datamodel.AbstractFile.getAtime ( )

Get the access time

Returns: access time

Definition at line 242 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.getAtimeAsDate ( )

Get the access time as Date (in local timezone)

Returns: access time as Date

Definition at line 251 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.epochToTime().

int org.sleuthkit.datamodel.AbstractFile.getAttributeId ( )

Get the attribute id

Returns: attribute id

Definition at line 197 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.attrId.

short org.sleuthkit.datamodel.AbstractFile.getAttrId ( )

Get the attribute id

Returns: attribute id

Deprecated:: Use getAttributeId() method instead as it returns integer instead of short.

Definition at line 1217 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.attrId.

TskData.TSK_FS_ATTR_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.getAttrType ( )

Get the attribute type

Returns: attribute type

Definition at line 188 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.attrType.

long org.sleuthkit.datamodel.AbstractFile.getCrtime ( )

Get the creation time

Returns: creation time

Definition at line 224 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.getCrtimeAsDate ( )

Get the creation time as Date (in local timezone)

Returns: creation time as Date

Definition at line 233 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.epochToTime().

long org.sleuthkit.datamodel.AbstractFile.getCtime ( )

Get the change time

Returns: change time

Definition at line 206 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.getCtimeAsDate ( )

Get the change time as Date (in local timezone)

Returns: change time as Date

Definition at line 215 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.epochToTime().

Content org.sleuthkit.datamodel.AbstractFile.getDataSource ( ) throws TskCoreException

Gets the data source for this file.

Returns: The data source.

Exceptions

TskCoreException if there was an error querying the case database.

Implements org.sleuthkit.datamodel.Content.

Definition at line 537 of file AbstractFile.java.

References org.sleuthkit.datamodel.SleuthkitCase.getContentById(), and org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase().

Referenced by org.sleuthkit.datamodel.LayoutFile.readInt().

String org.sleuthkit.datamodel.AbstractFile.getDirFlagAsString ( )

Returns: a string representation of the directory name flag (type TSK_FS_NAME_FLAG_ENUM)

Definition at line 737 of file AbstractFile.java.

References org.sleuthkit.datamodel.TskData.TSK_FS_NAME_FLAG_ENUM.toString().

TSK_FS_NAME_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.getDirType ( )

Get the directory type id

Returns: directory type id

Definition at line 716 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.dirType.

String org.sleuthkit.datamodel.AbstractFile.getDirTypeAsString ( )

Definition at line 720 of file AbstractFile.java.

int org.sleuthkit.datamodel.AbstractFile.getGid ( )

Get the group id

Returns: group id

Definition at line 287 of file AbstractFile.java.

TskData.FileKnown org.sleuthkit.datamodel.AbstractFile.getKnown ( )

Get "knownState" file status - after running a HashDB ingest on it As marked by a knownState file database, such as NSRL

Returns: file knownState status enum value

Definition at line 494 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.knownState.

Referenced by org.sleuthkit.datamodel.AbstractFile.save(), and org.sleuthkit.datamodel.SleuthkitCase.setKnown().

String org.sleuthkit.datamodel.AbstractFile.getLocalAbsPath ( )

Get local absolute path of the file, if localPath has been set

Returns: local absolute file path if local path has been set, or null

Definition at line 913 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.localAbsPath.

String org.sleuthkit.datamodel.AbstractFile.getLocalPath ( )

Get local relative to case db path of the file

Returns: local file path if set

Definition at line 904 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.localPath.

String org.sleuthkit.datamodel.AbstractFile.getMd5Hash ( )

Get the md5 hash value as calculated, if present

Returns: md5 hash string, if it is present or null if it is not

Definition at line 471 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.md5Hash.

Referenced by org.sleuthkit.datamodel.AbstractFile.save().

long org.sleuthkit.datamodel.AbstractFile.getMetaAddr ( )

Get the file meta address

Returns: Address of the meta data structure

Definition at line 296 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.metaAddr.

Referenced by org.sleuthkit.datamodel.FsContent.isRoot().

String org.sleuthkit.datamodel.AbstractFile.getMetaFlagsAsString ( )

Returns: a string representation of the meta flags

Definition at line 744 of file AbstractFile.java.

References org.sleuthkit.datamodel.TskData.TSK_FS_META_FLAG_ENUM.ALLOC, and org.sleuthkit.datamodel.TskData.TSK_FS_META_FLAG_ENUM.UNALLOC.

long org.sleuthkit.datamodel.AbstractFile.getMetaSeq ( )

Get the file meta address sequence. Only useful with NTFS. Incremented each time a structure is re-allocated.

Returns: Address of the meta data structure sequence.

Definition at line 306 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.metaSeq.

TSK_FS_META_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.getMetaType ( )

Get the meta data type

Returns: meta data type

Definition at line 703 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.metaType.

String org.sleuthkit.datamodel.AbstractFile.getMetaTypeAsString ( )

Definition at line 707 of file AbstractFile.java.

References org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM.toString().

String org.sleuthkit.datamodel.AbstractFile.getMIMEType ( )

Gets the MIME type of this file.

Returns: The MIME type name or null if the MIME type has not been set.

Definition at line 432 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.mimeType.

Referenced by org.sleuthkit.datamodel.AbstractFile.save().

String org.sleuthkit.datamodel.AbstractFile.getModesAsString ( )

Get the file's mode as a user-displayable string

Returns: formatted user-displayable string for mode

Definition at line 315 of file AbstractFile.java.

long org.sleuthkit.datamodel.AbstractFile.getMtime ( )

Get the modified time

Returns: modified time

Definition at line 260 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.getMtimeAsDate ( )

Get the modified time as Date (in local timezone)

Returns: modified time as Date

Definition at line 269 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.epochToTime().

String org.sleuthkit.datamodel.AbstractFile.getNameExtension ( )

Get the extension part of the filename, if there is one. We assume that extensions only have ASCII alphanumeric chars

Returns: The filename extension in lowercase (not including the period) or empty string if there is no extension

Definition at line 505 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.extension.

String org.sleuthkit.datamodel.AbstractFile.getParentPath ( )

Get path of the parent of this file

Returns: path string of the parent

Definition at line 524 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.parentPath.

Referenced by org.sleuthkit.datamodel.AbstractFile.close(), org.sleuthkit.datamodel.OSUtility.getOSInfoInternal(), and org.sleuthkit.datamodel.FsContent.getUniquePath().

List<TskFileRange> org.sleuthkit.datamodel.AbstractFile.getRanges ( ) throws TskCoreException

Gets file ranges associated with the file. File ranges are objects in tsk_file_layout table Any file type (especially unallocated) may have 1 or more block ranges associated with it

Returns: list of file layout ranges

Exceptions

TskCoreException exception thrown if critical error occurred within tsk core

Definition at line 560 of file AbstractFile.java.

References org.sleuthkit.datamodel.SleuthkitCase.getFileRanges(), org.sleuthkit.datamodel.AbstractContent.getId(), org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase(), and org.sleuthkit.datamodel.AbstractFile.ranges.

Referenced by org.sleuthkit.datamodel.AbstractFile.convertToImgOffset(), org.sleuthkit.datamodel.LayoutFile.getNumParts(), and org.sleuthkit.datamodel.LayoutFile.readInt().

long org.sleuthkit.datamodel.AbstractFile.getSize ( )

Get size of the file

Returns: file size in bytes

Implements org.sleuthkit.datamodel.Content.

Definition at line 515 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.size.

TskData.TSK_DB_FILES_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.getType ( )

Gets type of the abstract file as defined in TSK_DB_FILES_TYPE_ENUM

Returns: the type of the abstract file

Definition at line 179 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.fileType.

int org.sleuthkit.datamodel.AbstractFile.getUid ( )

Get the user id

Returns: user id

Definition at line 278 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.uid.

boolean org.sleuthkit.datamodel.AbstractFile.isDir ( )

Is this object a directory. Should return true for file system folders and virtual folders.

Returns: true if directory, false otherwise

Definition at line 631 of file AbstractFile.java.

References org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_DIR, and org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_VIRT_DIR.

Referenced by org.sleuthkit.datamodel.AbstractFile.readLocal().

boolean org.sleuthkit.datamodel.AbstractFile.isDirNameFlagSet ( TSK_FS_NAME_FLAG_ENUM flag )

Parameters

flag	the TSK_FS_NAME_FLAG_ENUM to check

Returns: true if the given flag is set in this FsContent object.

Definition at line 729 of file AbstractFile.java.

boolean org.sleuthkit.datamodel.AbstractFile.isFile ( )

Is this object a file. Should return true for all types of files, including file system, logical, derived, layout, and slack space for files.

Returns: true if a file, false otherwise

Definition at line 618 of file AbstractFile.java.

References org.sleuthkit.datamodel.TskData.TSK_FS_NAME_TYPE_ENUM.REG, org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_REG, and org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_UNDEF.

boolean org.sleuthkit.datamodel.AbstractFile.isMetaFlagSet ( TSK_FS_META_FLAG_ENUM metaFlag )

Parameters

metaFlag the TSK_FS_META_FLAG_ENUM to check

Returns: true if the given meta flag is set in this FsContent object.

Definition at line 759 of file AbstractFile.java.

MimeMatchEnum org.sleuthkit.datamodel.AbstractFile.isMimeType ( SortedSet< String > mimeTypes )

Determines if this file's type is one of the ones passed in. Uses the blackboard attribute for file type.

Parameters

mimeTypes Set of file types to compare against

Returns

Definition at line 1058 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.MimeMatchEnum.FALSE, org.sleuthkit.datamodel.AbstractFile.MimeMatchEnum.TRUE, and org.sleuthkit.datamodel.AbstractFile.MimeMatchEnum.UNDEFINED.

boolean org.sleuthkit.datamodel.AbstractFile.isModeSet ( TskData.TSK_FS_META_MODE_ENUM mode )

Definition at line 449 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.modes.

abstract boolean org.sleuthkit.datamodel.AbstractFile.isRoot ( )

abstract

Is this a root of a file system

Returns: true if root of a file system, false otherwise

boolean org.sleuthkit.datamodel.AbstractFile.isVirtual ( )

is this a virtual file or directory that was created by The Sleuth Kit or Autopsy for general structure and organization.

Returns: true if it's virtual, false otherwise

Definition at line 605 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.fileType, org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_VIRT, org.sleuthkit.datamodel.TskData.TSK_FS_NAME_TYPE_ENUM.VIRT, and org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM.VIRTUAL_DIR.

List<AbstractFile> org.sleuthkit.datamodel.AbstractFile.listFiles ( ) throws TskCoreException

Returns: a list of AbstractFiles that are the children of this Directory. Only returns children of type TskData.TSK_DB_FILES_TYPE_ENUM.FS.

Exceptions

org.sleuthkit.datamodel.TskCoreException

Definition at line 683 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractContent.getChildren().

void org.sleuthkit.datamodel.AbstractFile.loadLocalFile ( ) throws TskCoreException

private

Lazy load local file handle

Exceptions

org.sleuthkit.datamodel.TskCoreException If the local path is not set.

Definition at line 973 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.localFile.

Referenced by org.sleuthkit.datamodel.AbstractFile.canRead(), org.sleuthkit.datamodel.AbstractFile.exists(), and org.sleuthkit.datamodel.AbstractFile.readLocal().

final int org.sleuthkit.datamodel.AbstractFile.read	(	byte[]	buf,
		long	offset,
		long	len
	)		throws TskCoreException

Reads data that this content object is associated with (file contents, volume contents, etc.).

Parameters

buf	a character array of data (in bytes) to copy read data to
offset	byte offset in the content to start reading from
len	number of bytes to read into buf.

Returns: num of bytes read, or -1 on error

Exceptions

TskCoreException if critical error occurred during read in the tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 764 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.readInt(), and org.sleuthkit.datamodel.AbstractFile.readLocal().

int org.sleuthkit.datamodel.AbstractFile.readInt	(	byte[]	buf,
		long	offset,
		long	len
	)		throws TskCoreException

protected

Internal custom read (non-local) method that child classes can implement

Parameters

buf	buffer to read into
offset	start reading position in the file
len	number of bytes to read

Returns: number of bytes read

Exceptions

TskCoreException exception thrown when file could not be read

Definition at line 786 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.read().

final int org.sleuthkit.datamodel.AbstractFile.readLocal	(	byte[]	buf,
		long	offset,
		long	len
	)		throws TskCoreException

protected

Local file path read support

Parameters

buf	buffer to read into
offset	start reading position in the file
len	number of bytes to read

Returns: number of bytes read

Exceptions

TskCoreException exception thrown when file could not be read

Definition at line 801 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.canRead(), org.sleuthkit.datamodel.AbstractFile.encodingType, org.sleuthkit.datamodel.AbstractFile.exists(), org.sleuthkit.datamodel.AbstractFile.isDir(), org.sleuthkit.datamodel.AbstractFile.loadLocalFile(), org.sleuthkit.datamodel.AbstractFile.localAbsPath, org.sleuthkit.datamodel.AbstractFile.localFile, and org.sleuthkit.datamodel.TskData.EncodingType.NONE.

Referenced by org.sleuthkit.datamodel.AbstractFile.read().

void org.sleuthkit.datamodel.AbstractFile.save ( ) throws TskCoreException

Saves the editable file properties of this file to the case database, e.g., the MIME type, MD5 hash, and known state.

Exceptions

TskCoreException if there is an error saving the editable file properties to the case database.

Definition at line 1075 of file AbstractFile.java.

References org.sleuthkit.datamodel.SleuthkitCase.acquireSingleUserCaseWriteLock(), org.sleuthkit.datamodel.AbstractContent.getId(), org.sleuthkit.datamodel.AbstractFile.getKnown(), org.sleuthkit.datamodel.AbstractFile.getMd5Hash(), org.sleuthkit.datamodel.AbstractFile.getMIMEType(), org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase(), and org.sleuthkit.datamodel.SleuthkitCase.releaseSingleUserCaseWriteLock().

void org.sleuthkit.datamodel.AbstractFile.setKnown ( TskData.FileKnown knownState )

Sets the known state for this file.

IMPORTANT: The known state is set for this AbstractFile object, but it is not saved to the case database until AbstractFile.save is called.

Parameters

knownState The known state of the file.

Definition at line 483 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.knownState.

Referenced by org.sleuthkit.datamodel.SleuthkitCase.setKnown().

void org.sleuthkit.datamodel.AbstractFile.setLocalPath	(	String	localPath,
		boolean	isAbsolute
	)

protected

Set local path for the file, as stored in db tsk_files_path, relative to the case db path or an absolute path. When set, subsequent invocations of read() will read the file in the local path.

Parameters

localPath	local path to be set
isAbsolute	true if the path is absolute, false if relative to the case db

Deprecated:: Do not make subclasses outside of this package.

Definition at line 1242 of file AbstractFile.java.

void org.sleuthkit.datamodel.AbstractFile.setMd5Hash ( String md5Hash )

Sets the MD5 hash for this file.

IMPORTANT: The MD5 hash is set for this AbstractFile object, but it is not saved to the case database until AbstractFile.save is called.

Parameters

md5Hash The MD5 hash of the file.

Definition at line 461 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.md5Hash.

void org.sleuthkit.datamodel.AbstractFile.setMIMEType ( String mimeType )

Sets the MIME type for this file.

IMPORTANT: The MIME type is set for this AbstractFile object, but it is not saved to the case database until AbstractFile.save is called.

Parameters

mimeType The MIME type of this file.

Definition at line 444 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.mimeType.

Referenced by org.sleuthkit.datamodel.SleuthkitCase.setFileMIMEType().

static long org.sleuthkit.datamodel.AbstractFile.timeToEpoch ( String time )

static

Convert from ISO 8601 formatted date time string to epoch time in seconds

Parameters

time	formatted date time string as "yyyy-MM-dd HH:mm:ss"

Returns: epoch time in seconds

Definition at line 1289 of file AbstractFile.java.

References org.sleuthkit.datamodel.TimeUtilities.timeToEpoch().

String org.sleuthkit.datamodel.AbstractFile.toString ( boolean preserveState )

Definition at line 1020 of file AbstractFile.java.

References org.sleuthkit.datamodel.AbstractFile.attrType, org.sleuthkit.datamodel.AbstractFile.fileType, org.sleuthkit.datamodel.AbstractFile.knownState, org.sleuthkit.datamodel.AbstractFile.localFile, and org.sleuthkit.datamodel.AbstractFile.modes.

Member Data Documentation

final int org.sleuthkit.datamodel.AbstractFile.attrId

protected

Definition at line 57 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getAttributeId(), and org.sleuthkit.datamodel.AbstractFile.getAttrId().

final TskData.TSK_FS_ATTR_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.attrType

protected

Definition at line 58 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.AbstractFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getAttrType(), and org.sleuthkit.datamodel.AbstractFile.toString().

final ResourceBundle org.sleuthkit.datamodel.AbstractFile.BUNDLE = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle")

staticprivate

Definition at line 86 of file AbstractFile.java.

long org.sleuthkit.datamodel.AbstractFile.dataSourceObjectId

private

Definition at line 87 of file AbstractFile.java.

final TSK_FS_NAME_FLAG_ENUM org.sleuthkit.datamodel.AbstractFile.dirFlag

protected

Definition at line 51 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), and org.sleuthkit.datamodel.LocalFilesDataSource.LocalFilesDataSource().

final TSK_FS_NAME_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.dirType

protected

Definition at line 49 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getDirType(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), and org.sleuthkit.datamodel.LocalFilesDataSource.LocalFilesDataSource().

TskData.EncodingType org.sleuthkit.datamodel.AbstractFile.encodingType

private

Definition at line 66 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.readLocal().

final String org.sleuthkit.datamodel.AbstractFile.extension

private

Definition at line 88 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.getNameExtension().

final TskData.TSK_DB_FILES_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.fileType

protected

Definition at line 48 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.getType(), org.sleuthkit.datamodel.AbstractFile.isVirtual(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), and org.sleuthkit.datamodel.AbstractFile.toString().

TskData.FileKnown org.sleuthkit.datamodel.AbstractFile.knownState

protected

knownState status in database

Definition at line 76 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getKnown(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), org.sleuthkit.datamodel.LocalFilesDataSource.LocalFilesDataSource(), org.sleuthkit.datamodel.AbstractFile.setKnown(), and org.sleuthkit.datamodel.AbstractFile.toString().

boolean org.sleuthkit.datamodel.AbstractFile.knownStateDirty = false

private

Definition at line 77 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.localAbsPath

private

absolute path representation of the local path

Definition at line 63 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.getLocalAbsPath(), and org.sleuthkit.datamodel.AbstractFile.readLocal().

volatile java.io.File org.sleuthkit.datamodel.AbstractFile.localFile

private

Definition at line 65 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.canRead(), org.sleuthkit.datamodel.AbstractFile.exists(), org.sleuthkit.datamodel.AbstractFile.loadLocalFile(), org.sleuthkit.datamodel.AbstractFile.readLocal(), and org.sleuthkit.datamodel.AbstractFile.toString().

volatile RandomAccessFile org.sleuthkit.datamodel.AbstractFile.localFileHandle

private

Definition at line 64 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.localPath

private

local path as stored in db tsk_files_path, is relative to the db,

Definition at line 62 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.AbstractFile.getLocalPath(), and org.sleuthkit.datamodel.LocalFile.LocalFile().

boolean org.sleuthkit.datamodel.AbstractFile.localPathSet = false

private

if set by setLocalPath(), reads are done on local file

Definition at line 61 of file AbstractFile.java.

final Logger org.sleuthkit.datamodel.AbstractFile.LOGGER = Logger.getLogger(AbstractFile.class.getName())

staticprivate

Definition at line 85 of file AbstractFile.java.

String org.sleuthkit.datamodel.AbstractFile.md5Hash

protected

Definition at line 81 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getMd5Hash(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), and org.sleuthkit.datamodel.AbstractFile.setMd5Hash().

boolean org.sleuthkit.datamodel.AbstractFile.md5HashDirty = false

private

Definition at line 82 of file AbstractFile.java.

final long org.sleuthkit.datamodel.AbstractFile.metaAddr

protected

Definition at line 54 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getMetaAddr(), and org.sleuthkit.datamodel.FsContent.getMetaDataText().

final Set<TSK_FS_META_FLAG_ENUM> org.sleuthkit.datamodel.AbstractFile.metaFlags

protected

Definition at line 52 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), and org.sleuthkit.datamodel.LocalFile.LocalFile().

final int org.sleuthkit.datamodel.AbstractFile.metaSeq

protected

Definition at line 55 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), and org.sleuthkit.datamodel.AbstractFile.getMetaSeq().

final TSK_FS_META_TYPE_ENUM org.sleuthkit.datamodel.AbstractFile.metaType

protected

Definition at line 50 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getMetaType(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), and org.sleuthkit.datamodel.LocalFilesDataSource.LocalFilesDataSource().

String org.sleuthkit.datamodel.AbstractFile.mimeType

private

Definition at line 83 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.getMIMEType(), and org.sleuthkit.datamodel.AbstractFile.setMIMEType().

boolean org.sleuthkit.datamodel.AbstractFile.mimeTypeDirty = false

private

Definition at line 84 of file AbstractFile.java.

final Set<TskData.TSK_FS_META_MODE_ENUM> org.sleuthkit.datamodel.AbstractFile.modes

protected

Definition at line 59 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getModesAsString(), org.sleuthkit.datamodel.AbstractFile.isModeSet(), and org.sleuthkit.datamodel.AbstractFile.toString().

final String org.sleuthkit.datamodel.AbstractFile.parentPath

protected

Definition at line 72 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getParentPath(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), and org.sleuthkit.datamodel.LocalFile.LocalFile().

List<TskFileRange> org.sleuthkit.datamodel.AbstractFile.ranges

private

Definition at line 68 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.AbstractFile.getRanges().

long org.sleuthkit.datamodel.AbstractFile.size

protected

Definition at line 53 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.DerivedFile.DerivedFile(), org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), org.sleuthkit.datamodel.AbstractFile.getSize(), org.sleuthkit.datamodel.LayoutFile.LayoutFile(), org.sleuthkit.datamodel.LocalFile.LocalFile(), and org.sleuthkit.datamodel.FsContent.readInt().

final int org.sleuthkit.datamodel.AbstractFile.uid

protected

Definition at line 56 of file AbstractFile.java.

Referenced by org.sleuthkit.datamodel.Directory.Directory(), org.sleuthkit.datamodel.File.File(), and org.sleuthkit.datamodel.AbstractFile.getUid().

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

/home/carriersleuth/repos/sleuthkit/bindings/java/src/org/sleuthkit/datamodel/AbstractFile.java

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation