mirror of
https://github.com/overcuriousity/autopsy-flatpak.git
synced 2025-07-06 21:00:22 +00:00
44 lines
3.2 KiB
Plaintext
44 lines
3.2 KiB
Plaintext
/*! \page mod_result_page Developing Result Viewer Modules
|
|
|
|
\section result_overview Overview
|
|
DataResultViewer modules exist in the upper-right area of the default Autopsy interface, as shown below.
|
|
|
|
\image html viewer_image.jpg "Module Viewer Areas"
|
|
|
|
They display a set of files that are passed into the viewer from the tree on the left, keyword searching, or other searches. The main idea is that the same set of files can be viewed in table form, thumbnail form, or any other form that you can think of. Once a file is selected from the DataResult area, it is passed to the DataContent area for display.
|
|
|
|
\section result_dataflow Data Flow
|
|
This section provides some basics on DataResult viewers. DataResult viewers are created as needed. The directory tree on the left creates one when it loads and uses it for the life of the application. The keyword search module creates on each time it performs a keyword search. Data is explicitly passed into it.
|
|
|
|
By default, when a node is selected, it is then passed to the default DataContent viewer. There can be many data content viewers, but only one default one exists.
|
|
|
|
|
|
\section result_nb NetBeans Module Configuration
|
|
The rest of the document assumes that you have already created your NetBeans module, as outlined in \ref mod_dev_module.
|
|
|
|
DataResultViewer modules will have additional NetBeans dependencies. Right click on the module, choose "Properties" -> "Libraries" -> "Module Dependencies". Add "Lookup API" and "Nodes API".
|
|
|
|
\section result_mod Module Development
|
|
|
|
You will need a class that extends org.sleuthkit.autopsy.corecomponents.AbstractDataResultViewer. You can use NetBeans to make a class, manually extend it, and then let NetBeans complain about missing methods. It will provide default implementations for them if you click on the error messages in the UI.
|
|
Refer to the documentation in org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer on what each method should do. Note that AbstractDataResultViewer extends JPanel.
|
|
|
|
Autopsy will find your module using the NetBeans Lookup infrastructure. To be found, you will need to register as a service provider for DataResultViewer.class by annotating your class as follows:
|
|
|
|
\code
|
|
@ServiceProvider(service = DataResultViewer.class)
|
|
public class DataResultViewerTable extends AbstractDataResultViewer {
|
|
\endcode
|
|
|
|
If you get errors about not knowing about ServiceProviders and such, ensure that you configured your NetBeans module to depend on the Nodes and Lookup APIs as outlined in the previous section.
|
|
|
|
\section result_examples Example Modules
|
|
You can refer to the org.sleuthkit.autopsy.corecomponents.DataResultViewerTable and org.sleuthkit.autopsy.corecomponents.DataResultViewerThumbnail modules to follow as examples.
|
|
|
|
\section result_hint Hints
|
|
Note that these modules are currently the most challenging to develop because they require the most NetBeans knowledge about Nodes and ExplorerManagers. Make sure you read some of the tutorials (or books) first:
|
|
- NetBeans Nodes API Tutorial (https://platform.netbeans.org/tutorials/nbm-nodesapi2.html)
|
|
- NetBeans Nodes, Explorer Manager, and Component Palette Tutorial (https://platform.netbeans.org/tutorials/nbm-nodesapi3.html)
|
|
|
|
*/
|