Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type Class Reference

Inherits Serializable.

Public Member Functions

 Type (int typeId, String displayName, String dbTableName, Boolean supported, Boolean enabled) throws CentralRepoException
 
 Type (String displayName, String dbTableName, Boolean supported, Boolean enabled) throws CentralRepoException
 
boolean equals (Object that)
 
String getDbTableName ()
 
String getDisplayName ()
 
int getId ()
 
int hashCode ()
 
Boolean isEnabled ()
 
Boolean isSupported ()
 
void setDbTableName (String dbTableName) throws CentralRepoException
 
void setDisplayName (String displayName)
 
void setEnabled (Boolean enabled)
 
void setId (int typeId)
 
void setSupported (Boolean supported)
 
String toString ()
 

Private Member Functions

boolean sameType (CorrelationAttributeInstance.Type that)
 

Private Attributes

String dbTableName
 
String displayName
 
Boolean enabled
 
Boolean supported
 
int typeId
 

Static Private Attributes

static final String DB_NAMES_REGEX = "[a-z][a-z0-9_]*"
 

Detailed Description

Correlation Types which determine which table to query in the CR

Definition at line 318 of file CorrelationAttributeInstance.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.Type ( int  typeId,
String  displayName,
String  dbTableName,
Boolean  supported,
Boolean  enabled 
) throws CentralRepoException
Parameters
typeIdUnique ID for this Correlation Type
displayNameName of this type displayed in the UI.
dbTableNameCentral repository db table where data of this type is stored. Must start with a lowercase letter and only contain lowercase letters, numbers, and '_' characters.
supportedIs this Type currently supported
enabledIs this Type currently enabled.

Definition at line 340 of file CorrelationAttributeInstance.java.

org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.Type ( String  displayName,
String  dbTableName,
Boolean  supported,
Boolean  enabled 
) throws CentralRepoException

Constructor for custom types where we do not know the Type ID until the row has been entered into the correlation_types table in the central repository.

Parameters
displayNameName of this type displayed in the UI.
dbTableNameCentral repository db table where data of this type is stored Must start with a lowercase letter and only contain lowercase letters, numbers, and '_' characters.
supportedIs this Type currently supported
enabledIs this Type currently enabled.

Definition at line 367 of file CorrelationAttributeInstance.java.

Member Function Documentation

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.equals ( Object  that)

Determine if 2 Type objects are equal

Parameters
thatType object for comparison.
Returns
true or false

Definition at line 379 of file CorrelationAttributeInstance.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.getDbTableName ( )

To support having different database tables for each Type, this field provides the prefix/suffix of the table name, which allows us to automatically compute the table names and index names.

It is the prefix for the instances tables *_instances. (i.e. file_instances) It is the suffix for the reference tables reference_*. (i.e. reference_file)

When custom Types are added in the future, they are already supported by just giving the desired value for the table name for each custom Type. Possibly having all custom Types use a common table name.

Returns
the dbTableName

Definition at line 508 of file CorrelationAttributeInstance.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.getDisplayName ( )
int org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.getId ( )
int org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.hashCode ( )

Definition at line 404 of file CorrelationAttributeInstance.java.

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.isEnabled ( )

Check if this Artifact Type is enabled.

Returns
true or false

Definition at line 466 of file CorrelationAttributeInstance.java.

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.isSupported ( )

Check if this Artifact Type is supported.

Returns
true or false

Definition at line 448 of file CorrelationAttributeInstance.java.

boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.sameType ( CorrelationAttributeInstance.Type  that)
private

Determines if the content of this artifact type object is equivalent to the content of another artifact type object.

Parameters
thatthe other type
Returns
true if it is the same type

Definition at line 397 of file CorrelationAttributeInstance.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.setDbTableName ( String  dbTableName) throws CentralRepoException

To support having different database tables for each Type, this field provides the prefix/suffix of the table name, which allows us to automatically compute the table names and index names.

It is the prefix for the instances tables *_instances. (i.e. file_instances) It is the suffix for the reference tables reference_*. (i.e. reference_file)

When custom Types are added in the future, they are already supported by just giving the desired value for the table name for each custom Type. Possibly having all custom Types use a common table name. (i.e. custom_instances)

Parameters
dbTableNamethe dbTableName to set. Must start with lowercase letter and can only contain lowercase letters, numbers, and '_' characters.
Exceptions
CentralRepoExceptionif dbTableName contains invalid characters

Definition at line 532 of file CorrelationAttributeInstance.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.setDisplayName ( String  displayName)
Parameters
displayNamethe displayName to set

Definition at line 489 of file CorrelationAttributeInstance.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.setEnabled ( Boolean  enabled)

Set this Artifact Type as enabled or not enabled.

Parameters
enabledthe enabled to set

Definition at line 475 of file CorrelationAttributeInstance.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.setId ( int  typeId)
Parameters
typeIdthe typeId to set

Definition at line 439 of file CorrelationAttributeInstance.java.

void org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.setSupported ( Boolean  supported)

Set this Artifact Type as supported or not supported.

Parameters
supportedthe supported to set

Definition at line 457 of file CorrelationAttributeInstance.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.toString ( )

Definition at line 413 of file CorrelationAttributeInstance.java.

Member Data Documentation

final String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.DB_NAMES_REGEX = "[a-z][a-z0-9_]*"
staticprivate

Definition at line 325 of file CorrelationAttributeInstance.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.dbTableName
private

Definition at line 322 of file CorrelationAttributeInstance.java.

String org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.displayName
private

Definition at line 321 of file CorrelationAttributeInstance.java.

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.enabled
private

Definition at line 324 of file CorrelationAttributeInstance.java.

Boolean org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.supported
private

Definition at line 323 of file CorrelationAttributeInstance.java.

int org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type.typeId
private

Definition at line 320 of file CorrelationAttributeInstance.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Thu Sep 29 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.