Sleuth Kit Java Bindings (JNI)  4.6.0
Java bindings for using The Sleuth Kit
org.sleuthkit.datamodel.LocalFile Class Reference

Inherits org.sleuthkit.datamodel.AbstractFile.

Public Member Functions

List< TskFileRangegetRanges () 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 ()
 
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< TskFileRangegetRanges () 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< AbstractFilelistFiles () 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< BlackboardArtifactgetAllArtifacts () throws TskCoreException
 
long getAllArtifactsCount () throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (String artifactTypeName) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (int artifactTypeID) throws TskCoreException
 
ArrayList< BlackboardArtifactgetArtifacts (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< ContentgetChildren () 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< BlackboardAttributegetGenInfoAttributes (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< BlackboardAttributegetGenInfoAttributes (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)
 

Additional Inherited Members

- Static Public Member Functions inherited from org.sleuthkit.datamodel.AbstractFile
static String createNonUniquePath (String uniquePath)
 
static String epochToTime (long epoch)
 
static String epochToTime (long epoch, TimeZone tzone)
 
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 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_ENUMmetaFlags
 
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

A representation of a local/logical file (e.g., on a user's machine) that has been added to a 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

Constructs a representation of a local/logical file (e.g., on a user's machine) that has been added to the case database.

Parameters
dbThe case database to which the file has been added.
objIdThe object id of the file in the case database.
nameThe name of the file.
fileTypeThe type of the file.
dirTypeThe type of the file, usually as reported in the name structure of the file system. May be set to TSK_FS_NAME_TYPE_ENUM.UNDEF.
metaTypeThe type of the file, usually as reported in the metadata structure of the file system. May be set to TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_UNDEF.
dirFlagThe allocated status of the file, usually as reported in the name structure of the file system.
metaFlagsThe allocated status of the file, usually as reported in the metadata structure of the file system.
sizeThe size of the file.
ctimeThe changed time of the file.
crtimeThe created time of the file.
atimeThe accessed time of the file.
mtimeThe modified time of the file.
md5HashThe MD5 hash of the file, null if not yet calculated.
knownStateThe known state of the file from a hash database lookup, null if not yet looked up.
parentPathThe path of the parent of the file.
localPathThe absolute path of the file in secondary storage.
Deprecated:
Do not make subclasses outside of this package.

Definition at line 202 of file LocalFile.java.

References org.sleuthkit.datamodel.AbstractFile.dirFlag, org.sleuthkit.datamodel.AbstractFile.dirType, org.sleuthkit.datamodel.AbstractFile.fileType, org.sleuthkit.datamodel.AbstractFile.knownState, org.sleuthkit.datamodel.AbstractFile.md5Hash, org.sleuthkit.datamodel.AbstractFile.metaFlags, org.sleuthkit.datamodel.AbstractFile.metaType, org.sleuthkit.datamodel.TskData.EncodingType.NONE, org.sleuthkit.datamodel.AbstractFile.parentPath, org.sleuthkit.datamodel.AbstractFile.size, and org.sleuthkit.datamodel.AbstractContent.UNKNOWN_ID.

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

Constructs a representation of a local/logical file (e.g., on a user's machine) that has been added to the case database.

Parameters
dbThe case database to which the file has been added.
objIdThe object id of the file in the case database.
nameThe name of the file.
fileTypeThe type of the file.
dirTypeThe type of the file, usually as reported in the name structure of the file system. May be set to TSK_FS_NAME_TYPE_ENUM.UNDEF.
metaTypeThe type of the file, usually as reported in the metadata structure of the file system. May be set to TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_UNDEF.
dirFlagThe allocated status of the file, usually as reported in the name structure of the file system.
metaFlagsThe allocated status of the file, usually as reported in the metadata structure of the file system.
sizeThe size of the file.
ctimeThe changed time of the file.
crtimeThe created time of the file.
atimeThe accessed time of the file.
mtimeThe modified time of the file.
md5HashThe MD5 hash of the file, null if not yet calculated.
knownStateThe known state of the file from a hash database lookup, null if not yet looked up.
parentPathThe path of the parent of the file.
localPathThe absolute path of the file in secondary storage.
parentIdThe object id of parent of the file.
Deprecated:
Do not make subclasses outside of this package.

Definition at line 261 of file LocalFile.java.

References org.sleuthkit.datamodel.AbstractFile.dirFlag, org.sleuthkit.datamodel.AbstractFile.dirType, org.sleuthkit.datamodel.AbstractFile.fileType, org.sleuthkit.datamodel.AbstractFile.knownState, org.sleuthkit.datamodel.AbstractFile.md5Hash, org.sleuthkit.datamodel.AbstractFile.metaFlags, org.sleuthkit.datamodel.AbstractFile.metaType, 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

Constructs a representation of a local/logical file (e.g., on a user's machine) that has been added to the case.

Parameters
dbThe case database to which the file has been added.
objIdThe object id of the file in the case database.
nameThe name of the file.
dirTypeThe type of the file, usually as reported in the name structure of the file system. May be set to TSK_FS_NAME_TYPE_ENUM.UNDEF.
metaTypeThe type of the file, usually as reported in the metadata structure of the file system. May be set to TSK_FS_META_TYPE_ENUM.TSK_FS_META_TYPE_UNDEF.
dirFlagThe allocated status of the file, usually as reported in the name structure of the file system.
metaFlagsThe allocated status of the file, usually as reported in the metadata structure of the file system.
sizeThe size of the file.
ctimeThe changed time of the file.
crtimeThe created time of the file.
atimeThe accessed time of the file.
mtimeThe modified time of the file.
md5HashThe MD5 hash of the file, null if not yet calculated.
knownStateThe known state of the file from a hash database lookup, null if not yet looked up.
parentPathThe path of the parent of the file.
localPathThe absolute path of the file in secondary storage.
parentIdThe object id of parent of the file.
Deprecated:
Do not make subclasses outside of this package.

Definition at line 306 of file LocalFile.java.

References 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.md5Hash, org.sleuthkit.datamodel.AbstractFile.metaFlags, org.sleuthkit.datamodel.AbstractFile.metaType, org.sleuthkit.datamodel.AbstractFile.parentPath, and org.sleuthkit.datamodel.AbstractFile.size.

Member Function Documentation

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

Gets the extents in terms of byte addresses of this local file within its data source, an empty list.

Returns
An empty list of extents (TskFileRange objects)
Exceptions
TskCoreExceptionif there was an error querying the case database.

Definition at line 115 of file LocalFile.java.

boolean org.sleuthkit.datamodel.LocalFile.isRoot ( )

Indicates whether or not this local file is the root of a file system, always returns false.

Returns
False.

Definition at line 126 of file LocalFile.java.

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

Provides a string representation of this local file.

Parameters
preserveStateTrue if state should be included in the string representation of this object.

Definition at line 165 of file LocalFile.java.


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

Copyright © 2011-2018 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.