org.sleuthkit.datamodel.LocalFile Class Reference

Inherits org.sleuthkit.datamodel.AbstractFile.

Public Member Functions
List< Content >	getChildren () throws TskCoreException
List< Long >	getChildrenIds () throws TskCoreException
List< TskFileRange >	getRanges () throws TskCoreException
boolean	isRoot ()
String	toString (boolean preserveState)
Public Member Functions inherited from org.sleuthkit.datamodel.AbstractFile
boolean	canRead ()
void	close ()
long	convertToImgOffset (long fileOffset) throws TskCoreException
boolean	exists ()
long	getAtime ()
String	getAtimeAsDate ()
short	getAttrId ()
TskData.TSK_FS_ATTR_TYPE_ENUM	getAttrType ()
long	getCrtime ()
String	getCrtimeAsDate ()
long	getCtime ()
String	getCtimeAsDate ()
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	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
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
int	getChildrenCount () 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
long	getArtifactsCount (BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException
ArrayList< BlackboardAttribute >	getGenInfoAttributes (BlackboardAttribute.ATTRIBUTE_TYPE attr_type) throws TskCoreException

Protected Member Functions
	LocalFile (SleuthkitCase db, long objId, String name, TSK_DB_FILES_TYPE_ENUM fileType, 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, String md5Hash, FileKnown knownState, String parentPath, String localPath)
	LocalFile (SleuthkitCase db, long objId, String name, TSK_DB_FILES_TYPE_ENUM fileType, 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, String md5Hash, FileKnown knownState, String parentPath, String localPath, long parentId)
	LocalFile (SleuthkitCase db, long objId, String name, 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, String md5Hash, FileKnown knownState, String parentPath, String localPath, long parentId)
Protected Member Functions inherited from 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)
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)

Static Private Attributes
static final Logger	logger = Logger.getLogger(LocalFile.class.getName())

Additional Inherited Members
Static Public Member Functions inherited from org.sleuthkit.datamodel.AbstractFile
static String	createNonUniquePath (String uniquePath)
static String	epochToTime (long epoch)
static long	timeToEpoch (String time)
Static Public Attributes inherited from org.sleuthkit.datamodel.AbstractContent
static final long	UNKNOWN_ID = -1
Protected Attributes inherited from org.sleuthkit.datamodel.AbstractFile
final short	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

Detailed Description

Represents a local file (on user's machine) that has been added to the case

Definition at line 34 of file LocalFile.java.

Constructor & Destructor Documentation

org.sleuthkit.datamodel.LocalFile.LocalFile ( SleuthkitCase  db, long  objId, String  name, TSK_DB_FILES_TYPE_ENUM  fileType, 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, String  md5Hash, FileKnown  knownState, String  parentPath, String  localPath  )

protected

Create a db representation of a local file, passing a more specific file type

Parameters

db
objId	object if of this file already in database
name	name of this local file
fileType	TSK_DB_FILES_TYPE_ENUM type of the file (local of more specific)
dirType
metaType
dirFlag
metaFlags
size	size of the file
ctime
crtime
atime
mtime
md5Hash
knownState
parentPath	path of the parent of this local file (e.g. fs zip file, or another local file path)
localPath	local absolute path of this local file

Definition at line 62 of file LocalFile.java.

References org.sleuthkit.datamodel.TskData.TSK_FS_ATTR_TYPE_ENUM.TSK_FS_ATTR_TYPE_DEFAULT.

org.sleuthkit.datamodel.LocalFile.LocalFile ( SleuthkitCase  db, long  objId, String  name, TSK_DB_FILES_TYPE_ENUM  fileType, 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, String  md5Hash, FileKnown  knownState, String  parentPath, String  localPath, long  parentId  )

protected

Create a db representation of a local file, passing a more specific file type

Parameters

db
objId	object if of this file already in database
name	name of this local file
fileType	TSK_DB_FILES_TYPE_ENUM type of the file (LOCAL or more specific)
dirType
metaType
dirFlag
metaFlags
size	size of the file
ctime
crtime
atime
mtime
md5Hash
knownState
parentPath	path of the parent of this local file (e.g. virtual dir or another local file path)
localPath	local path of this local file, relative to the db path
parentId	parent id of this local file to set if available

Definition at line 101 of file LocalFile.java.

References org.sleuthkit.datamodel.AbstractContent.db, org.sleuthkit.datamodel.AbstractFile.dirFlag, org.sleuthkit.datamodel.AbstractFile.dirType, org.sleuthkit.datamodel.AbstractFile.fileType, org.sleuthkit.datamodel.AbstractFile.knownState, org.sleuthkit.datamodel.AbstractFile.localPath, org.sleuthkit.datamodel.AbstractFile.md5Hash, org.sleuthkit.datamodel.AbstractFile.metaFlags, org.sleuthkit.datamodel.AbstractFile.metaType, org.sleuthkit.datamodel.AbstractContent.name, org.sleuthkit.datamodel.AbstractContent.objId, org.sleuthkit.datamodel.AbstractFile.parentPath, and org.sleuthkit.datamodel.AbstractFile.size.

org.sleuthkit.datamodel.LocalFile.LocalFile ( SleuthkitCase  db, long  objId, String  name, 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, String  md5Hash, FileKnown  knownState, String  parentPath, String  localPath, long  parentId  )

protected

Create a db representation of a local file

Parameters

db
objId	object if of this file already in database
name	name of this local file
dirType
metaType
dirFlag
metaFlags
size	size of the file
ctime
crtime
atime
mtime
md5Hash
knownState
parentPath	path of the parent of this local file (e.g. virtual dir or another local file path)
localPath	local path of this local file, relative to the db path
parentId	parent id of this local file to set if available

Definition at line 134 of file LocalFile.java.

References org.sleuthkit.datamodel.AbstractContent.db, org.sleuthkit.datamodel.AbstractFile.dirFlag, org.sleuthkit.datamodel.AbstractFile.dirType, org.sleuthkit.datamodel.AbstractFile.knownState, org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM.LOCAL, org.sleuthkit.datamodel.AbstractFile.localPath, org.sleuthkit.datamodel.AbstractFile.md5Hash, org.sleuthkit.datamodel.AbstractFile.metaFlags, org.sleuthkit.datamodel.AbstractFile.metaType, org.sleuthkit.datamodel.AbstractContent.name, org.sleuthkit.datamodel.AbstractContent.objId, org.sleuthkit.datamodel.AbstractFile.parentPath, and org.sleuthkit.datamodel.AbstractFile.size.

Member Function Documentation

List<Content> org.sleuthkit.datamodel.LocalFile.getChildren

(

)

throws TskCoreException

Gets the child content objects of this content.

Returns

List of children

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 157 of file LocalFile.java.

References org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM.DERIVED, org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase(), and org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM.LOCAL.

List<Long> org.sleuthkit.datamodel.LocalFile.getChildrenIds

(

)

throws TskCoreException

Gets the child content ids of this content.

Returns

List of children ids

Exceptions

TskCoreException

if critical error occurred within tsk core

Implements org.sleuthkit.datamodel.Content.

Definition at line 167 of file LocalFile.java.

References org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM.DERIVED, org.sleuthkit.datamodel.AbstractContent.getSleuthkitCase(), and org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM.LOCAL.

List<TskFileRange> org.sleuthkit.datamodel.LocalFile.getRanges

(

)

throws TskCoreException

Definition at line 141 of file LocalFile.java.

boolean org.sleuthkit.datamodel.LocalFile.isRoot

(

)

Definition at line 146 of file LocalFile.java.

String org.sleuthkit.datamodel.LocalFile.toString

(

boolean

preserveState

)

Definition at line 182 of file LocalFile.java.

Member Data Documentation

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

staticprivate

Definition at line 36 of file LocalFile.java.

---

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

• bindings/java/src/org/sleuthkit/datamodel/LocalFile.java