|
Sleuth Kit Java Bindings (JNI) 4.14.0
Java bindings for using The Sleuth Kit
|
Inherits org.sleuthkit.datamodel.SleuthkitVisitableItem.
Inherited by org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.DataSource, and org.sleuthkit.datamodel.Report.
Interface for all datatypes that can be found in the database. Content objects make up a tree and each object can have a parent and children. For example, the child of an Image object is a Volume or File System. This interface defines the basic methods for reading the content associated with this object, the parent and children, and adding artifacts.
Definition at line 33 of file Content.java.
| public< T > T org.sleuthkit.datamodel.Content.accept | ( | ContentVisitor< T > | v | ) |
Visitor pattern support
| v | visitor supplying an algorithm to run on the content object |
| void org.sleuthkit.datamodel.Content.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.
Implemented in org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.FileSystem, org.sleuthkit.datamodel.FsContent, org.sleuthkit.datamodel.HostAddress, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.LayoutFile, org.sleuthkit.datamodel.OsAccount, org.sleuthkit.datamodel.Pool, org.sleuthkit.datamodel.Report, org.sleuthkit.datamodel.SpecialDirectory, org.sleuthkit.datamodel.UnsupportedContent, org.sleuthkit.datamodel.Volume, and org.sleuthkit.datamodel.VolumeSystem.
Referenced by org.sleuthkit.datamodel.SleuthkitCase.getAllReports().
| Score org.sleuthkit.datamodel.Content.getAggregateScore | ( | ) | throws TskCoreException |
Returns the final score for the content object.
| TskCoreException | if critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getAggregateScore().
Referenced by getAggregateScore().
| List< AnalysisResult > org.sleuthkit.datamodel.Content.getAllAnalysisResults | ( | ) | throws TskCoreException |
Get all analysis results associated with this content.
| TskCoreException | If critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getAllAnalysisResults().
Referenced by getAllAnalysisResults().
| ArrayList< BlackboardArtifact > org.sleuthkit.datamodel.Content.getAllArtifacts | ( | ) | throws TskCoreException |
Get all artifacts associated with this content
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getAllArtifacts().
Referenced by getAllArtifacts().
| long org.sleuthkit.datamodel.Content.getAllArtifactsCount | ( | ) | throws TskCoreException |
Get count of all artifacts associated with this content
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getAllArtifactsCount().
Referenced by getAllArtifactsCount().
| List< DataArtifact > org.sleuthkit.datamodel.Content.getAllDataArtifacts | ( | ) | throws TskCoreException |
Get all data artifacts associated with this content.
| TskCoreException | If critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getAllDataArtifacts().
Referenced by getAllDataArtifacts().
| List< AnalysisResult > org.sleuthkit.datamodel.Content.getAnalysisResults | ( | BlackboardArtifact.Type | artifactType | ) | throws TskCoreException |
Get all analysis results associated with this content, that have the given type.
| artifactType | Type to look up. |
| TskCoreException | If critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, and org.sleuthkit.datamodel.Report.
References getAnalysisResults().
Referenced by getAnalysisResults().
| ArrayList< BlackboardArtifact > org.sleuthkit.datamodel.Content.getArtifacts | ( | BlackboardArtifact.ARTIFACT_TYPE | type | ) | throws TskCoreException |
Get all artifacts associated with this content that have the given type
| type | type to look up |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getArtifacts().
| ArrayList< BlackboardArtifact > org.sleuthkit.datamodel.Content.getArtifacts | ( | int | artifactTypeID | ) | throws TskCoreException |
Get all artifacts associated with this content that have the given type id
| artifactTypeID | type id to look up |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getArtifacts().
| ArrayList< BlackboardArtifact > org.sleuthkit.datamodel.Content.getArtifacts | ( | String | artifactTypeName | ) | throws TskCoreException |
Get all artifacts associated with this content that have the given type name
| artifactTypeName | name of the type to look up |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getArtifacts().
Referenced by getArtifacts(), getArtifacts(), and getArtifacts().
| long org.sleuthkit.datamodel.Content.getArtifactsCount | ( | BlackboardArtifact.ARTIFACT_TYPE | type | ) | throws TskCoreException |
Get count of all artifacts associated with this content that have the given type
| type | type to look up |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getArtifactsCount().
| long org.sleuthkit.datamodel.Content.getArtifactsCount | ( | int | artifactTypeID | ) | throws TskCoreException |
Get count of all artifacts associated with this content that have the given type id
| artifactTypeID | type id to look up |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getArtifactsCount().
| long org.sleuthkit.datamodel.Content.getArtifactsCount | ( | String | artifactTypeName | ) | throws TskCoreException |
Get count of all artifacts associated with this content that have the given type name
| artifactTypeName | name of the type to look up |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getArtifactsCount().
Referenced by getArtifactsCount(), getArtifactsCount(), and getArtifactsCount().
| List< Content > org.sleuthkit.datamodel.Content.getChildren | ( | ) | throws TskCoreException |
Gets the child content objects of this content.
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.Pool, org.sleuthkit.datamodel.Report, org.sleuthkit.datamodel.Volume, and org.sleuthkit.datamodel.VolumeSystem.
References getChildren().
Referenced by org.sleuthkit.datamodel.SleuthkitCase.addCarvedFiles(), getChildren(), and org.sleuthkit.datamodel.Examples.Sample.run().
| int org.sleuthkit.datamodel.Content.getChildrenCount | ( | ) | throws TskCoreException |
Returns count of children objects. Note, this should be more efficient than getting children and counting them.
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getChildrenCount().
Referenced by getChildrenCount().
| List< Long > org.sleuthkit.datamodel.Content.getChildrenIds | ( | ) | throws TskCoreException |
Gets the child content ids of this content.
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.Pool, org.sleuthkit.datamodel.Report, org.sleuthkit.datamodel.Volume, and org.sleuthkit.datamodel.VolumeSystem.
References getChildrenIds().
Referenced by getChildrenIds().
| Content org.sleuthkit.datamodel.Content.getDataSource | ( | ) | throws TskCoreException |
Gets the root data source (image, virtual directory, etc.) of this content.
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.FsContent, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.Report, and org.sleuthkit.datamodel.VirtualDirectory.
References getDataSource().
Referenced by org.sleuthkit.datamodel.AbstractContent.getDataSource(), and getDataSource().
| BlackboardArtifact org.sleuthkit.datamodel.Content.getGenInfoArtifact | ( | ) | throws TskCoreException |
Return the TSK_GEN_INFO artifact for the file so that individual attributes can be added to it. Creates one if it does not already exist.
| TskCoreException |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getGenInfoArtifact().
Referenced by getGenInfoArtifact(), and getGenInfoArtifact().
| BlackboardArtifact org.sleuthkit.datamodel.Content.getGenInfoArtifact | ( | boolean | create | ) | throws TskCoreException |
Return the TSK_GEN_INFO artifact for the file so that individual attributes can be added to it. If one does not create, behavior depends on the create argument.
| create | If true, an artifact will be created if it does not already exist. |
| TskCoreException |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getGenInfoArtifact().
| ArrayList< BlackboardAttribute > org.sleuthkit.datamodel.Content.getGenInfoAttributes | ( | BlackboardAttribute.ATTRIBUTE_TYPE | attr_type | ) | throws TskCoreException |
Return attributes of a given type from TSK_GEN_INFO.
| attr_type | Attribute type to find inside of the TSK_GEN_INFO artifact. |
Implemented in org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getGenInfoAttributes().
Referenced by getGenInfoAttributes().
| Set< String > org.sleuthkit.datamodel.Content.getHashSetNames | ( | ) | throws TskCoreException |
Get the names of all the hashsets that this content is in.
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getHashSetNames().
Referenced by getHashSetNames().
| long org.sleuthkit.datamodel.Content.getId | ( | ) |
Returns the unique object ID that was assigned to it in the database. This is a Sleuth Kit database-assigned number.
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.HostAddress, org.sleuthkit.datamodel.OsAccount, and org.sleuthkit.datamodel.Report.
References getId().
Referenced by org.sleuthkit.datamodel.OsAccount.OsAccountAttribute.OsAccountAttribute(), org.sleuthkit.datamodel.OsAccount.OsAccountAttribute.OsAccountAttribute(), org.sleuthkit.datamodel.OsAccount.OsAccountAttribute.OsAccountAttribute(), org.sleuthkit.datamodel.OsAccount.OsAccountAttribute.OsAccountAttribute(), org.sleuthkit.datamodel.OsAccount.OsAccountAttribute.OsAccountAttribute(), org.sleuthkit.datamodel.SleuthkitCase.addCarvedFiles(), org.sleuthkit.datamodel.SleuthkitCase.addCarvedFiles(), getId(), org.sleuthkit.datamodel.AbstractContent.newAnalysisResult(), org.sleuthkit.datamodel.BlackboardArtifact.newAnalysisResult(), org.sleuthkit.datamodel.Report.newAnalysisResult(), org.sleuthkit.datamodel.Report.newArtifact(), and org.sleuthkit.datamodel.AbstractContent.toString().
| String org.sleuthkit.datamodel.Content.getName | ( | ) |
Get the name of this content object (does not include parent path)
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
Referenced by org.sleuthkit.datamodel.LocalFilesDataSource.getUniquePath().
| Content org.sleuthkit.datamodel.Content.getParent | ( | ) | throws TskCoreException |
| TskCoreException |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References getParent().
Referenced by org.sleuthkit.datamodel.SleuthkitCase.addCarvedFiles(), getParent(), and org.sleuthkit.datamodel.SleuthkitCase.updateDerivedFile().
| long org.sleuthkit.datamodel.Content.getSize | ( | ) |
Get the (reported) size of the content object and, in theory, how much you should be able to read from it. In some cases, data corruption may mean that you cannot read this much data.
Implemented in org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.FileSystem, org.sleuthkit.datamodel.HostAddress, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.OsAccount, org.sleuthkit.datamodel.Pool, org.sleuthkit.datamodel.Report, org.sleuthkit.datamodel.UnsupportedContent, org.sleuthkit.datamodel.Volume, and org.sleuthkit.datamodel.VolumeSystem.
Referenced by org.sleuthkit.datamodel.Pool.getSize().
| String org.sleuthkit.datamodel.Content.getUniquePath | ( | ) | throws TskCoreException |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.LocalFilesDataSource, org.sleuthkit.datamodel.Report, and org.sleuthkit.datamodel.Volume.
Referenced by org.sleuthkit.datamodel.AbstractContent.getUniquePath(), org.sleuthkit.datamodel.AbstractFile.getUniquePath(), org.sleuthkit.datamodel.BlackboardArtifact.getUniquePath(), and org.sleuthkit.datamodel.Volume.getUniquePath().
| boolean org.sleuthkit.datamodel.Content.hasChildren | ( | ) | throws TskCoreException |
Returns true if the content object has children objects. Note, this should be more efficient than getting children and checking it empty.
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References hasChildren().
Referenced by hasChildren().
| AnalysisResultAdded org.sleuthkit.datamodel.Content.newAnalysisResult | ( | BlackboardArtifact.Type | artifactType, |
| Score | score, | ||
| String | conclusion, | ||
| String | configuration, | ||
| String | justification, | ||
| Collection< BlackboardAttribute > | attributesList ) throws TskCoreException |
Create and add an analysis result associated with this content.
| artifactType | Type of analysis result artifact to create. |
| score | Score associated with this analysis. |
| conclusion | Conclusion from the analysis, may be empty. |
| configuration | Configuration element associated with this analysis, may be empty. |
| justification | Justification |
| attributesList | Additional attributes to attach to this analysis result artifact. |
| TskCoreException | if critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, and org.sleuthkit.datamodel.Report.
References newAnalysisResult().
Referenced by newAnalysisResult(), newAnalysisResult(), and org.sleuthkit.datamodel.SleuthkitCase.newBlackboardArtifact().
| AnalysisResultAdded org.sleuthkit.datamodel.Content.newAnalysisResult | ( | BlackboardArtifact.Type | artifactType, |
| Score | score, | ||
| String | conclusion, | ||
| String | configuration, | ||
| String | justification, | ||
| Collection< BlackboardAttribute > | attributesList, | ||
| long | dataSourceId ) throws TskCoreException |
Create and add an analysis result associated with this content.
| artifactType | Type of analysis result artifact to create. |
| score | Score associated with this analysis. |
| conclusion | Conclusion from the analysis, may be empty. |
| configuration | Configuration element associated with this analysis, may be empty. |
| justification | Justification |
| attributesList | Additional attributes to attach to this analysis result artifact. |
| dataSourceId | The data source for the analysis result |
| TskCoreException | if critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, and org.sleuthkit.datamodel.Report.
References newAnalysisResult().
| BlackboardArtifact org.sleuthkit.datamodel.Content.newArtifact | ( | BlackboardArtifact.ARTIFACT_TYPE | type | ) | throws TskCoreException |
Create and add an artifact associated with this content to the blackboard
| type | artifact enum tyoe |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References newArtifact().
| BlackboardArtifact org.sleuthkit.datamodel.Content.newArtifact | ( | int | artifactTypeID | ) | throws TskCoreException |
Create and add an artifact associated with this content to the blackboard
| artifactTypeID | id of the artifact type (if the id doesn't already exist an exception will be thrown) |
| TskCoreException | if critical error occurred within tsk core |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.BlackboardArtifact, and org.sleuthkit.datamodel.Report.
References newArtifact().
Referenced by newArtifact(), and newArtifact().
| DataArtifact org.sleuthkit.datamodel.Content.newDataArtifact | ( | BlackboardArtifact.Type | artifactType, |
| Collection< BlackboardAttribute > | attributesList ) throws TskCoreException |
Create and add a data artifact associated with this abstract file. This method creates the data artifact with the os account id associated with this abstract file if one exists.
| artifactType | Type of data artifact to create. |
| attributesList | Additional attributes to attach to this data artifact. |
| TskCoreException | If a critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, org.sleuthkit.datamodel.AbstractFile, and org.sleuthkit.datamodel.Report.
References newDataArtifact().
Referenced by org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.addArea(), org.sleuthkit.datamodel.blackboardutils.CommunicationArtifactsHelper.addCalllog(), org.sleuthkit.datamodel.blackboardutils.CommunicationArtifactsHelper.addContact(), org.sleuthkit.datamodel.blackboardutils.ArtifactsHelper.addInstalledProgram(), org.sleuthkit.datamodel.blackboardutils.CommunicationArtifactsHelper.addMessage(), org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.addRoute(), org.sleuthkit.datamodel.blackboardutils.GeoArtifactsHelper.addTrack(), org.sleuthkit.datamodel.blackboardutils.WebBrowserArtifactsHelper.addWebBookmark(), org.sleuthkit.datamodel.blackboardutils.WebBrowserArtifactsHelper.addWebCookie(), org.sleuthkit.datamodel.blackboardutils.WebBrowserArtifactsHelper.addWebDownload(), org.sleuthkit.datamodel.blackboardutils.WebBrowserArtifactsHelper.addWebFormAddress(), org.sleuthkit.datamodel.blackboardutils.WebBrowserArtifactsHelper.addWebFormAutofill(), org.sleuthkit.datamodel.blackboardutils.WebBrowserArtifactsHelper.addWebHistory(), org.sleuthkit.datamodel.SleuthkitCase.newBlackboardArtifact(), newDataArtifact(), newDataArtifact(), and newDataArtifact().
| DataArtifact org.sleuthkit.datamodel.Content.newDataArtifact | ( | BlackboardArtifact.Type | artifactType, |
| Collection< BlackboardAttribute > | attributesList, | ||
| Long | osAccountId ) throws TskCoreException |
Create and add a data artifact associated with this content.
| artifactType | Type of analysis result artifact to create. |
| attributesList | Additional attributes to attach to this data artifact. |
| osAccountId | The OS account id associated with the artifact. May be null. |
| TskCoreException | If a critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, and org.sleuthkit.datamodel.Report.
References newDataArtifact().
| DataArtifact org.sleuthkit.datamodel.Content.newDataArtifact | ( | BlackboardArtifact.Type | artifactType, |
| Collection< BlackboardAttribute > | attributesList, | ||
| Long | osAccountId, | ||
| long | dataSourceId ) throws TskCoreException |
Create and add a data artifact associated with this content.
| artifactType | Type of analysis result artifact to create. |
| attributesList | Additional attributes to attach to this data artifact. |
| osAccountId | The OS account id associated with the artifact. May be null. |
| dataSourceId | The data source id of the artifact |
| TskCoreException | If a critical error occurred within tsk core. |
Implemented in org.sleuthkit.datamodel.AbstractContent, and org.sleuthkit.datamodel.Report.
References newDataArtifact().
| int org.sleuthkit.datamodel.Content.read | ( | byte[] | buf, |
| long | offset, | ||
| long | len ) throws TskCoreException |
Reads data that this content object is associated with (file contents, volume contents, etc.).
| 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. |
| TskCoreException | if critical error occurred during read in the tsk core |
Implemented in org.sleuthkit.datamodel.AbstractFile, org.sleuthkit.datamodel.BlackboardArtifact, org.sleuthkit.datamodel.FileSystem, org.sleuthkit.datamodel.HostAddress, org.sleuthkit.datamodel.Image, org.sleuthkit.datamodel.OsAccount, org.sleuthkit.datamodel.Pool, org.sleuthkit.datamodel.Report, org.sleuthkit.datamodel.UnsupportedContent, org.sleuthkit.datamodel.Volume, and org.sleuthkit.datamodel.VolumeSystem.
Copyright © 2011-2024 Brian Carrier. (carrier -at- sleuthkit -dot- org)
This work is licensed under a
Creative Commons Attribution-Share Alike 3.0 United States License.