Autopsy
4.19.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
|
Classes | |
class | CaseMetadataException |
Public Member Functions | |
CaseMetadata (Path metadataFilePath) throws CaseMetadataException | |
String | getCaseDatabaseName () |
String | getCaseDatabasePath () throws UnsupportedOperationException |
CaseDetails | getCaseDetails () |
String | getCaseDirectory () |
String | getCaseDisplayName () |
String | getCaseName () |
String | getCaseNotes () |
String | getCaseNumber () |
Case.CaseType | getCaseType () |
String | getCreatedDate () |
String | getExaminer () |
String | getExaminerEmail () |
String | getExaminerPhone () |
Path | getFilePath () |
String | getTextIndexName () |
Static Public Member Functions | |
static Path | getCaseMetadataFilePath (Path directoryPath) |
static DateFormat | getDateFormat () |
static String | getFileExtension () |
Private Member Functions | |
void | createCaseElements (Document doc, Element caseElement, CaseMetadata metadataToWrite) |
void | createChildElement (Document doc, Element parentElement, String elementName, String elementContent) |
void | createXMLDOM (Document doc) |
String | getElementTextContent (Element parentElement, String elementName, boolean contentIsRequired) throws CaseMetadataException |
void | readFromFile () throws CaseMetadataException |
Private Attributes | |
String | caseDatabaseName |
String | caseDatabasePath |
CaseDetails | caseDetails |
String | caseName |
Case.CaseType | caseType |
String | createdByVersion |
String | createdDate |
final Path | metadataFilePath |
CaseMetadata | originalMetadata = null |
String | textIndexName |
Static Private Attributes | |
static final String | AUTOPSY_CREATED_BY_ELEMENT_NAME = "CreatedByAutopsyVersion" |
static final String | AUTOPSY_SAVED_BY_ELEMENT_NAME = "SavedByAutopsyVersion" |
static final String | AUTOPSY_VERSION_ELEMENT_NAME = "AutopsyCreatedVersion" |
static final String | CASE_DATABASE_NAME_ELEMENT_NAME = "DatabaseName" |
static final String | CASE_DB_ABSOLUTE_PATH_ELEMENT_NAME = "Database" |
static final String | CASE_DB_NAME_RELATIVE_ELEMENT_NAME = "CaseDatabase" |
static final String | CASE_DISPLAY_NAME_ELEMENT_NAME = "DisplayName" |
static final String | CASE_ELEMENT_NAME = "Case" |
static final String | CASE_ELEMENT_NOTES = "CaseNotes" |
static final String | CASE_NAME_ELEMENT_NAME = "Name" |
static final String | CASE_NUMBER_ELEMENT_NAME = "Number" |
static final String | CASE_TYPE_ELEMENT_NAME = "CaseType" |
static final String | CREATED_DATE_ELEMENT_NAME = "CreatedDate" |
static final String | CURRENT_SCHEMA_VERSION = SCHEMA_VERSION_FIVE |
static final DateFormat | DATE_FORMAT = new SimpleDateFormat(DATE_FORMAT_STRING, Locale.US) |
static final String | DATE_FORMAT_STRING = "yyyy/MM/dd HH:mm:ss (z)" |
static final String | EXAMINER_ELEMENT_EMAIL = "ExaminerEmail" |
static final String | EXAMINER_ELEMENT_NAME = "Examiner" |
static final String | EXAMINER_ELEMENT_PHONE = "ExaminerPhone" |
static final String | FILE_EXTENSION = ".aut" |
static final String | MODIFIED_DATE_ELEMENT_NAME = "ModifiedDate" |
static final String | ORIGINAL_CASE_ELEMENT_NAME = "OriginalCase" |
static final String | ROOT_ELEMENT_NAME = "AutopsyCase" |
static final String | SCHEMA_VERSION_ELEMENT_NAME = "SchemaVersion" |
static final String | SCHEMA_VERSION_FIVE = "5.0" |
static final String | SCHEMA_VERSION_FOUR = "4.0" |
static final String | SCHEMA_VERSION_ONE = "1.0" |
static final String | SCHEMA_VERSION_THREE = "3.0" |
static final String | SCHEMA_VERSION_TWO = "2.0" |
static final String | TEXT_INDEX_ELEMENT = "TextIndex" |
static final String | TEXT_INDEX_NAME_ELEMENT = "TextIndexName" |
Provides access to the case metadata stored in the case metadata file.
Definition at line 55 of file CaseMetadata.java.
org.sleuthkit.autopsy.casemodule.CaseMetadata.CaseMetadata | ( | Path | metadataFilePath | ) | throws CaseMetadataException |
Constructs a CaseMetadata object for an existing case. The metadata is read from an existing case metadata file.
metadataFilePath | The full path to the case metadata file. |
CaseMetadataException | If the new case metadata file cannot be read. |
Definition at line 190 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.metadataFilePath, and org.sleuthkit.autopsy.casemodule.CaseMetadata.readFromFile().
|
private |
Write the case element children for the given metadata object
doc | The document. |
caseElement | The case element parent |
metadataToWrite | The CaseMetadata object to read from |
Definition at line 487 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseDatabaseName, org.sleuthkit.autopsy.casemodule.CaseMetadata.caseDatabasePath, org.sleuthkit.autopsy.casemodule.CaseMetadata.caseDetails, org.sleuthkit.autopsy.casemodule.CaseMetadata.caseName, org.sleuthkit.autopsy.casemodule.CaseMetadata.caseType, org.sleuthkit.autopsy.casemodule.CaseMetadata.createChildElement(), org.sleuthkit.autopsy.casemodule.CaseDetails.getCaseDisplayName(), org.sleuthkit.autopsy.casemodule.CaseDetails.getCaseNotes(), org.sleuthkit.autopsy.casemodule.CaseDetails.getCaseNumber(), org.sleuthkit.autopsy.casemodule.CaseDetails.getExaminerEmail(), org.sleuthkit.autopsy.casemodule.CaseDetails.getExaminerName(), org.sleuthkit.autopsy.casemodule.CaseDetails.getExaminerPhone(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.textIndexName.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createXMLDOM().
|
private |
Creates an XML element for the case metadata XML DOM.
doc | The document. |
parentElement | The parent element of the element to be created. |
elementName | The name of the element to be created. |
elementContent | The text content of the element to be created, may be empty. |
Definition at line 511 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createCaseElements(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.createXMLDOM().
|
private |
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDatabaseName | ( | ) |
Gets the name of the case database.
Definition at line 316 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseDatabaseName.
Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase(), and org.sleuthkit.autopsy.casemodule.Case.openCaseDataBase().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDatabasePath | ( | ) | throws UnsupportedOperationException |
Gets the full path to the case database file if the case is a single-user case.
UnsupportedOperationException | If called for a multi-user case. |
Definition at line 669 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseType, org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), and org.sleuthkit.autopsy.casemodule.Case.CaseType.SINGLE_USER_CASE.
CaseDetails org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDetails | ( | ) |
Get current values for the case details which are user modifiable.
Definition at line 257 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseDetails.
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory | ( | ) |
Gets the case directory.
Definition at line 230 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.acquireCaseLock(), org.sleuthkit.autopsy.casemodule.Case.createCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.createCaseDirectoryIfDoesNotExist(), org.sleuthkit.autopsy.casemodule.Case.deleteCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), org.sleuthkit.autopsy.casemodule.Case.deleteSingleUserCase(), org.sleuthkit.autopsy.keywordsearch.SolrSearchService.deleteTextIndex(), org.sleuthkit.autopsy.casemodule.Case.doCloseCaseAction(), org.sleuthkit.autopsy.casemodule.Case.doOpenCaseAction(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDatabasePath(), org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.openCaseDataBase(), org.sleuthkit.autopsy.casemodule.CaseMetadata.readFromFile(), and org.sleuthkit.autopsy.casemodule.Case.updateCaseNodeData().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDisplayName | ( | ) |
Gets the case display name.
Definition at line 266 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.deleteCase(), org.sleuthkit.autopsy.casemodule.Case.deleteFromRecentCases(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), org.sleuthkit.autopsy.casemodule.Case.deleteSingleUserCase(), and org.sleuthkit.autopsy.casemodule.Case.getDisplayName().
|
static |
Locate the case meta data file in the supplied directory. If the file does not exist, null is returned.
directoryPath | Directory path to search. |
Definition at line 203 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.getFileExtension().
Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getCaseMetadata().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseName | ( | ) |
Gets the unique and immutable case name.
Definition at line 248 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseName.
Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), org.sleuthkit.autopsy.casemodule.Case.deleteSingleUserCase(), org.sleuthkit.autopsy.casemodule.Case.doOpenCaseAction(), org.sleuthkit.autopsy.casemodule.Case.getName(), and org.sleuthkit.autopsy.casemodule.Case.openCommunicationChannels().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseNotes | ( | ) |
Definition at line 307 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getCaseNotes(), and org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseNumber | ( | ) |
Gets the case number.
Definition at line 286 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getNumber(), and org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase().
Case.CaseType org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType | ( | ) |
Gets the case type.
Definition at line 239 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseType.
Referenced by org.sleuthkit.autopsy.casemodule.Case.close(), org.sleuthkit.autopsy.casemodule.Case.createCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.createCaseDirectoryIfDoesNotExist(), org.sleuthkit.autopsy.casemodule.Case.deleteCase(), org.sleuthkit.autopsy.casemodule.Case.doCloseCaseAction(), org.sleuthkit.autopsy.casemodule.Case.doOpenCaseAction(), org.sleuthkit.autopsy.casemodule.Case.getCaseType(), org.sleuthkit.autopsy.casemodule.Case.getOutputDirectory(), org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase(), org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase(), org.sleuthkit.autopsy.casemodule.Case.openCaseDataBase(), and org.sleuthkit.autopsy.casemodule.Case.openCommunicationChannels().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getCreatedDate | ( | ) |
Gets the date the case was created.
Definition at line 353 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.createdDate.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getCreatedDate(), and org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase().
|
static |
Gets the date format used for dates in case metadata.
Definition at line 139 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeData().
|
private |
Gets the text content of an XML element.
parentElement | The parent element. |
elementName | The element name. |
contentIsRequired | Whether or not the content is required. |
CaseMetadataException | If the element is missing or content is required and it is empty. |
Definition at line 630 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.readFromFile().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getExaminer | ( | ) |
Gets the examiner.
Definition at line 295 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getExaminer(), and org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getExaminerEmail | ( | ) |
Definition at line 303 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getExaminerEmail(), and org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getExaminerPhone | ( | ) |
Definition at line 299 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getExaminerPhone(), and org.sleuthkit.autopsy.casemodule.SingleUserCaseConverter.importCase().
|
static |
Gets the file extension used for case metadata files.
Definition at line 130 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.FILE_EXTENSION.
Referenced by org.sleuthkit.autopsy.casemodule.CaseOpenAction.CaseOpenAction(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseMetadataFilePath().
Path org.sleuthkit.autopsy.casemodule.CaseMetadata.getFilePath | ( | ) |
Gets the full path to the case metadata file.
Definition at line 221 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.metadataFilePath.
Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteFromRecentCases(), org.sleuthkit.autopsy.casemodule.DeleteDataSourceAction.DataSourceDeletionWorker.doInBackground(), org.sleuthkit.autopsy.apputils.ResetWindowsAction.performAction(), org.sleuthkit.autopsy.casemodule.CaseMetadata.readFromFile(), and org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened().
String org.sleuthkit.autopsy.casemodule.CaseMetadata.getTextIndexName | ( | ) |
Gets the text index name. This is a legacy field and will be empty for cases created with Autopsy 4.4.0 and above.
Definition at line 344 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.textIndexName.
Referenced by org.sleuthkit.autopsy.casemodule.Case.getTextIndexName().
|
private |
Reads the case metadata from the metadata file.
CaseMetadataException | If there is an error reading from the case metadata file. |
Definition at line 523 of file CaseMetadata.java.
References org.sleuthkit.autopsy.casemodule.CaseMetadata.caseDatabaseName, org.sleuthkit.autopsy.casemodule.CaseMetadata.caseName, org.sleuthkit.autopsy.casemodule.CaseMetadata.caseType, org.sleuthkit.autopsy.casemodule.Case.CaseType.fromString(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getElementTextContent(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getFilePath().
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.CaseMetadata().
|
staticprivate |
Definition at line 81 of file CaseMetadata.java.
|
staticprivate |
Definition at line 110 of file CaseMetadata.java.
|
staticprivate |
Definition at line 68 of file CaseMetadata.java.
|
staticprivate |
Definition at line 74 of file CaseMetadata.java.
|
staticprivate |
Definition at line 82 of file CaseMetadata.java.
|
staticprivate |
Definition at line 90 of file CaseMetadata.java.
|
staticprivate |
Definition at line 89 of file CaseMetadata.java.
|
staticprivate |
Definition at line 69 of file CaseMetadata.java.
|
staticprivate |
Definition at line 98 of file CaseMetadata.java.
|
staticprivate |
Definition at line 70 of file CaseMetadata.java.
|
staticprivate |
Definition at line 71 of file CaseMetadata.java.
|
staticprivate |
Definition at line 73 of file CaseMetadata.java.
|
private |
|
private |
Definition at line 119 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createCaseElements().
|
private |
Definition at line 117 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createCaseElements(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDetails().
|
private |
Definition at line 116 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createCaseElements(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseName(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.readFromFile().
|
private |
Definition at line 115 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createCaseElements(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDatabasePath(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.readFromFile().
|
staticprivate |
Definition at line 67 of file CaseMetadata.java.
|
private |
Definition at line 122 of file CaseMetadata.java.
|
private |
Definition at line 121 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.getCreatedDate().
|
staticprivate |
Definition at line 112 of file CaseMetadata.java.
|
staticprivate |
Definition at line 59 of file CaseMetadata.java.
|
staticprivate |
Definition at line 58 of file CaseMetadata.java.
|
staticprivate |
Definition at line 97 of file CaseMetadata.java.
|
staticprivate |
Definition at line 72 of file CaseMetadata.java.
|
staticprivate |
Definition at line 96 of file CaseMetadata.java.
|
staticprivate |
Definition at line 57 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.getFileExtension().
|
private |
Definition at line 114 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.CaseMetadata(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getFilePath().
|
staticprivate |
Definition at line 109 of file CaseMetadata.java.
|
staticprivate |
Definition at line 104 of file CaseMetadata.java.
|
private |
Definition at line 123 of file CaseMetadata.java.
|
staticprivate |
Definition at line 65 of file CaseMetadata.java.
|
staticprivate |
Definition at line 66 of file CaseMetadata.java.
|
staticprivate |
Definition at line 103 of file CaseMetadata.java.
|
staticprivate |
Definition at line 95 of file CaseMetadata.java.
|
staticprivate |
Definition at line 64 of file CaseMetadata.java.
|
staticprivate |
Definition at line 88 of file CaseMetadata.java.
|
staticprivate |
Definition at line 80 of file CaseMetadata.java.
|
staticprivate |
Definition at line 83 of file CaseMetadata.java.
|
staticprivate |
Definition at line 75 of file CaseMetadata.java.
|
private |
Definition at line 120 of file CaseMetadata.java.
Referenced by org.sleuthkit.autopsy.casemodule.CaseMetadata.createCaseElements(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getTextIndexName().
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.