Autopsy  4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.url.analytics.DomainCategorizer Interface Reference

Inherits AutoCloseable.

Inherited by org.sleuthkit.autopsy.recentactivity.DefaultDomainCategorizer, org.sleuthkit.autopsy.recentactivity.DefaultPriorityDomainCategorizer, and org.sleuthkit.autopsy.url.analytics.domaincategorization.CustomWebCategorizer.

Public Member Functions

default void close () throws Exception
 
DomainCategory getCategory (String domain, String host) throws DomainCategorizerException
 
default void initialize () throws DomainCategorizerException
 

Detailed Description

Interface providing the category of a domain/host. Implementers of this class should have a no-argument constructor in order to be properly instantiated, and should have a class annotation of '(at)ServiceProvider(service = DomainCategoryProvider.class)'.

NOTE: The (at)SuppressWarnings("try") on the class is to suppress warnings relating to the fact that the close method can throw an InterruptedException since Exception can encompass the InterruptedException. See the following github issue and bugs for more information: https://github.com/joyent/java-manta/issues/322#issuecomment-326391239, https://bugs.openjdk.java.net/browse/JDK-8155591, https://bugs.eclipse.org/bugs/show_bug.cgi?id=350279.

Definition at line 39 of file DomainCategorizer.java.

Member Function Documentation

default void org.sleuthkit.autopsy.url.analytics.DomainCategorizer.close ( ) throws Exception

These providers close methods are explicitly called when ingest is finished. Conceivably, the same instance of this class may have this method called multiple times and should handle that possibility gracefully.

Exceptions
Exception

Implemented in org.sleuthkit.autopsy.recentactivity.DefaultDomainCategorizer, org.sleuthkit.autopsy.recentactivity.DefaultPriorityDomainCategorizer, and org.sleuthkit.autopsy.url.analytics.domaincategorization.CustomWebCategorizer.

Definition at line 71 of file DomainCategorizer.java.

DomainCategory org.sleuthkit.autopsy.url.analytics.DomainCategorizer.getCategory ( String  domain,
String  host 
) throws DomainCategorizerException

Provides the DomainCategory for a given domain/host or null if none can be determined.

Parameters
domainThe domain of the url.
hostThe host of the url.
Returns
The domain category if the domain/host combination was found or null if not.

Implemented in org.sleuthkit.autopsy.recentactivity.DefaultDomainCategorizer, org.sleuthkit.autopsy.recentactivity.DefaultPriorityDomainCategorizer, and org.sleuthkit.autopsy.url.analytics.domaincategorization.CustomWebCategorizer.

default void org.sleuthkit.autopsy.url.analytics.DomainCategorizer.initialize ( ) throws DomainCategorizerException

Initializes this provider in preparation to handle 'getCategory' requests during ingest. Conceivably, the same instance of this class may have this called multiple times and should handle that possibility gracefully.

Exceptions
DomainCategorizerException

Implemented in org.sleuthkit.autopsy.recentactivity.DefaultDomainCategorizer, org.sleuthkit.autopsy.url.analytics.domaincategorization.CustomWebCategorizer, and org.sleuthkit.autopsy.recentactivity.DefaultPriorityDomainCategorizer.

Definition at line 59 of file DomainCategorizer.java.


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

Copyright © 2012-2021 Basis Technology. Generated on: Fri Aug 6 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.