diff --git a/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java b/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java index e3b36499f0..1a9e947b76 100644 --- a/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java +++ b/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java @@ -26,6 +26,8 @@ import org.sleuthkit.datamodel.TskCoreException; /** * An interface for implementations of a keyword search service. + * You can find the implementations by using Lookup, such as: + * Lookup.getDefault().lookup(KeywordSearchService.class) * * TODO (AUT-2158: This interface should not extend Closeable. */ diff --git a/docs/doxygen/modReport.dox b/docs/doxygen/modReport.dox index 1e28a5a78d..6199ce7560 100644 --- a/docs/doxygen/modReport.dox +++ b/docs/doxygen/modReport.dox @@ -75,6 +75,19 @@ Typically a general report module should interact with both the Blackboard API i You should call org.sleuthkit.autopsy.casemodule.Case.addReport() with the path to your report so that it is shown in the Autopsy tree. You can specify a specific file or folder and the user can then view it later. +\subsection report_create_module_indexing Indexing Reports + +After you have called org.sleuthkit.autopsy.casemodule.Case.addReport() and created a report, you can pass it to org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService.index() so that it is indexed and can then be found by a user. This is most commonly used when an Ingest Module runs a 3rd party tool and the output of that tool is added back into Autopsy as a report. Here is some example code: + +\code{.java} +KeywordSearchService searchService = Lookup.getDefault().lookup(KeywordSearchService.class); +if (null == searchService) { + logger.log(Level.WARNING, "Keyword search service not found. Report will not be indexed"); +} else { + searchService.index(report); +} +\endcode + \subsection report_create_module_layer Installing your Report Module Report modules developed using Java must be registered in a layer.xml file. This file allows Autopsy to find the report module.