diff --git a/docs/doxygen/modDev.dox b/docs/doxygen/modDev.dox index 217650b587..7ce7cfc4eb 100644 --- a/docs/doxygen/modDev.dox +++ b/docs/doxygen/modDev.dox @@ -101,11 +101,19 @@ TODO we should outline the process of adding a JAR file dependency for an extern E.g. adding jar directly to the module project, or (preferred) wrapping set of jars in another module e.g. NewModuleName-Libs and adding a dependency on the libs module. Add info how to bundle OS-specific dlls in the jar (work in progress). +\section mod_dev_services Services -\section mod_dev_services Getting Access to Services +A Services class is provided to give developers access to the services provided by the Autopsy framework. Currently, the following +services are provided: -Autopsy-Core module contains the core Autopsy application, and also the framework the application is built upon that other modules can use. -Among the Core APIs there are general services available to the Autopsy modules. The relevant packages include: +- FileManager: the org.sleuthkit.autopsy.casemodule.services.FileManager service provides an API for easy access to files and directories for a given image. +You can access the org.sleuthkit.autopsy.casemodule.services.FileManager service by calling the getFileManager() method of the +org.sleuthkit.autopsy.casemodule.services.Services class. + +\section mod_dev_utilities Utilities + +Autopsy-Core module contains the core Autopsy application and also the framework the application is built upon that other modules can use. +Among the Core APIs there are general utilities available to the Autopsy modules. The relevant packages include: - org.sleuthkit.autopsy.casemodule.Case class - for the module to access Case data (TSK database) and subscribe to Case change events - org.sleuthkit.autopsy.coreutils package has classes providing utilities for getting access to Autopsy loggers, configuration persistance API, @@ -115,7 +123,7 @@ Relevant service classes are org.sleuthkit.autopsy.coreutils.Version, org.sleuthkit.autopsy.coreutils.PlatformUtil, org.sleuthkit.autopsy.coreutils.ModuleSettings, org.sleuthkit.autopsy.coreutils.Logger and org.sleuthkit.autopsy.coreutils.FileUtil. -TODO: Add additional info about service classes (log, Case, database, etc.) Similar to the C++ section about services (http://sleuthkit.org/sleuthkit/docs/framework-docs/mod_devpage.html) +TODO: Add additional info about utility classes (log, Case, database, etc.) Similar to the C++ section about services (http://sleuthkit.org/sleuthkit/docs/framework-docs/mod_devpage.html) TODO: Move the log content from the wiki (http://wiki.sleuthkit.org/index.php?title=Autopsy_3_Logging_and_Error_Checking) to here. diff --git a/docs/doxygen/platformConcepts.dox b/docs/doxygen/platformConcepts.dox index f33fa5f460..7e51941a82 100644 --- a/docs/doxygen/platformConcepts.dox +++ b/docs/doxygen/platformConcepts.dox @@ -3,7 +3,8 @@ \section platform_basics Basic Concepts - Central Database: All data except for the disk image is stored in a SQLite database. This includes information about what files exist in the disk image and the output from modules. Access to this database can be found from the SleuthKitCase class. -- Services: There are core services that the platform provides to modules. See the \ref mod_dev_services section for more details. +- Utilities: There are core utilities that the platform provides to modules. See the \ref mod_dev_utilities section for more details. +- Services: There are services provided by the platform. See the \ref mod_dev_services section for more details. - Pipelines and Plug-in Modules: The platform has several places where plug-in modules can be incorporated. This modular approach allows other developers to extend the functionality of the system. See the \ref platform_frameworks section for more details. - Blackboard: The platform uses the blackboard to enable modules to communicate with each other and to display data in the GUI. See the \ref platform_blackboard section for more details. - Single tree: Results from the various modules can generally be found in a single tree. This makes it easy for users to find their results.