Classes
class	CancelButtonListener

enum	CaseType

enum	Events

class	TaskThreadFactory

Public Member Functions
Image	addImage (String imgPath, long imgId, String timeZone) throws CaseActionException

void	addReport (String localPath, String srcModuleName, String reportName) throws TskCoreException

Report	addReport (String localPath, String srcModuleName, String reportName, Content parent) throws TskCoreException

void	closeCase () throws CaseActionException

void	deleteReports (Collection<?extends Report > reports) throws TskCoreException

void	deleteReports (Collection<?extends Report > reports, boolean deleteFromDisk) throws TskCoreException

List< Report >	getAllReports () throws TskCoreException

String	getCacheDirectory ()

String	getCaseDirectory ()

String	getCaseNotes ()

CaseType	getCaseType ()

String	getCreatedDate ()

List< Content >	getDataSources () throws TskCoreException

String	getDisplayName ()

String	getExaminer ()

String	getExaminerEmail ()

String	getExaminerPhone ()

String	getExportDirectory ()

String	getLogDirectoryPath ()

String	getModuleDirectory ()

String	getModuleOutputDirectoryRelativePath ()

String	getModulesOutputDirAbsPath ()

String	getName ()

String	getNumber ()

String	getOutputDirectory ()

String	getReportDirectory ()

Services	getServices ()

SleuthkitCase	getSleuthkitCase ()

String	getTempDirectory ()

String	getTextIndexName ()

Set< TimeZone >	getTimeZone ()

Set< TimeZone >	getTimeZones ()

boolean	hasData ()

void	notifyAddingDataSource (UUID eventId)

void	notifyBlackBoardArtifactTagAdded (BlackboardArtifactTag newTag)

void	notifyBlackBoardArtifactTagDeleted (BlackboardArtifactTag deletedTag)

void	notifyContentTagAdded (ContentTag newTag)

void	notifyContentTagDeleted (ContentTag deletedTag)

void	notifyDataSourceAdded (Content dataSource, UUID addingDataSourceEventId)

void	notifyFailedAddingDataSource (UUID addingDataSourceEventId)

void	notifyTagDefinitionChanged (String changedTagName)

Static Public Member Functions
static void	addEventSubscriber (Set< String > eventNames, PropertyChangeListener subscriber)

static void	addEventSubscriber (String eventName, PropertyChangeListener subscriber)

static void	addEventTypeSubscriber (Set< Events > eventTypes, PropertyChangeListener subscriber)

static void	addPropertyChangeListener (PropertyChangeListener listener)

static void	closeCurrentCase () throws CaseActionException

static String	convertTimeZone (String timeZoneId)

static void	create (String caseDir, String caseDisplayName, String caseNumber, String examiner) throws CaseActionException

static void	create (String caseDir, String caseDisplayName, String caseNumber, String examiner, CaseType caseType) throws CaseActionException

static void	createAsCurrentCase (String caseDir, String caseDisplayName, String caseNumber, String examiner, CaseType caseType) throws CaseActionException, CaseActionCancelledException

static void	createAsCurrentCase (CaseType caseType, String caseDir, CaseDetails caseDetails) throws CaseActionException, CaseActionCancelledException

static void	createCaseDirectory (String caseDir, CaseType caseType) throws CaseActionException

static void	deleteCase (CaseMetadata metadata) throws CaseActionException

static void	deleteCurrentCase () throws CaseActionException

static boolean	existsCurrentCase ()

static String	getAppName ()

static String	getAutopsyVersion ()

static Case	getCurrentCase ()

static Case	getCurrentCaseThrows () throws NoCurrentCaseException

static String	getModulesOutputDirRelPath ()

static PropertyChangeSupport	getPropertyChangeSupport ()

static void	invokeStartupDialog ()

static boolean	isCaseOpen ()

static boolean	isValidName (String caseName)

static void	open (String caseMetadataFilePath) throws CaseActionException

static void	openAsCurrentCase (String caseMetadataFilePath) throws CaseActionException

static boolean	pathExists (String filePath)

static void	removeEventSubscriber (String eventName, PropertyChangeListener subscriber)

static void	removeEventSubscriber (Set< String > eventNames, PropertyChangeListener subscriber)

static void	removeEventTypeSubscriber (Set< Events > eventTypes, PropertyChangeListener subscriber)

static void	removePropertyChangeListener (PropertyChangeListener listener)

Private Member Functions
	Case (CaseType caseType, String caseDir, CaseDetails caseDetails)

	Case (CaseMetadata caseMetaData)

void	acquireSharedCaseDirLock (String caseDir) throws CaseActionException

void	close () throws CaseActionException

void	close (ProgressIndicator progressIndicator)

void	closeAppServiceCaseResources ()

void	createCaseData (ProgressIndicator progressIndicator) throws CaseActionException

String	getOrCreateSubdirectory (String subDirectoryName)

void	open (boolean isNewCase) throws CaseActionException

void	open (boolean isNewCase, ProgressIndicator progressIndicator) throws CaseActionException

void	openAppServiceCaseResources () throws CaseActionException

void	openCaseData (ProgressIndicator progressIndicator) throws CaseActionException

void	openServices (ProgressIndicator progressIndicator) throws CaseActionException

void	releaseSharedCaseDirLock (String caseDir)

Static Private Member Functions
static CoordinationService.Lock	acquireExclusiveCaseResourcesLock (String caseDir) throws CaseActionException

static void	clearTempSubDir (String tempSubDirPath)

static void	deleteCase (CaseMetadata metadata, ProgressIndicator progressIndicator) throws CaseActionException

static String	displayNameToUniqueName (String caseDisplayName)

static String	getNameForTitle ()

static void	openAsCurrentCase (Case newCurrentCase, boolean isNewCase) throws CaseActionException, CaseActionCancelledException

static void	updateGUIForCaseClosed ()

static void	updateGUIForCaseOpened (Case newCurrentCase)

Private Attributes
SleuthkitCase	caseDb

CoordinationService.Lock	caseDirLock

volatile ExecutorService	caseLockingExecutor

Services	caseServices

CollaborationMonitor	collaborationMonitor

boolean	hasDataSources

final CaseMetadata	metadata

Static Private Attributes
static final String	CACHE_FOLDER = "Cache"

static final String	CASE_ACTION_THREAD_NAME = "%s-case-action"

static final String	CASE_RESOURCES_THREAD_NAME = "%s-manage-case-resources"

static final Object	caseActionSerializationLock = new Object()

static volatile Case	currentCase

static final int	DIR_LOCK_TIMOUT_HOURS = 12

static final String	EVENT_CHANNEL_NAME = "%s-Case-Events"

static final AutopsyEventPublisher	eventPublisher = new AutopsyEventPublisher()

static final String	EXPORT_FOLDER = "Export"

static final String	LOG_FOLDER = "Log"

static final Logger	logger = Logger.getLogger(Case.class.getName())

static volatile Frame	mainFrame

static final String	MODULE_FOLDER = "ModuleOutput"

static final String	REPORTS_FOLDER = "Reports"

static final int	RESOURCES_LOCK_TIMOUT_HOURS = 12

static final String	SINGLE_USER_CASE_DB_NAME = "autopsy.db"

static final String	TEMP_FOLDER = "Temp"

Detailed Description

An Autopsy case. Currently, only one case at a time may be open.

Definition at line 122 of file Case.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.casemodule.Case.Case	(	CaseType	caseType,
		String	caseDir,
		CaseDetails	caseDetails
	)

private

Constructs a Case object for a new Autopsy case.

Parameters

caseType	The type of case (single-user or multi-user).
caseDir	The full path of the case directory. The directory will be created if it doesn't already exist; if it exists, it is ASSUMED it was created by calling createCaseDirectory.
caseDetails	Contains details of the case, such as examiner, display name, etc

Definition at line 1675 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.displayNameToUniqueName(), and org.sleuthkit.autopsy.casemodule.CaseDetails.getCaseDisplayName().

Referenced by org.sleuthkit.autopsy.casemodule.Case.createAsCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

org.sleuthkit.autopsy.casemodule.Case.Case ( CaseMetadata caseMetaData )

private

Constructs a Case object for an existing Autopsy case.

Parameters

caseMetaData The metadata for the case.

Definition at line 1684 of file Case.java.

Member Function Documentation

static CoordinationService.Lock org.sleuthkit.autopsy.casemodule.Case.acquireExclusiveCaseResourcesLock ( String caseDir ) throws CaseActionException

staticprivate

Acquires an exclusive case resources lock.

Parameters

caseDir The full path of the case directory.

Returns: The lock.

Exceptions

CaseActionException with a user-friendly message if the lock cannot be acquired.

Definition at line 1009 of file Case.java.

References org.sleuthkit.autopsy.coordinationservice.CoordinationService.CategoryNode.CASES, org.sleuthkit.autopsy.coordinationservice.CoordinationService.getInstance(), and org.sleuthkit.autopsy.coordinationservice.CoordinationService.tryGetExclusiveLock().

Referenced by org.sleuthkit.autopsy.casemodule.Case.close(), and org.sleuthkit.autopsy.casemodule.Case.open().

void org.sleuthkit.autopsy.casemodule.Case.acquireSharedCaseDirLock ( String caseDir ) throws CaseActionException

private

Acquires a shared case directory lock for the current case.

Parameters

caseDir The full path of the case directory.

Exceptions

CaseActionException with a user-friendly message if the lock cannot be acquired.

Definition at line 2341 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseDirLock, org.sleuthkit.autopsy.coordinationservice.CoordinationService.CategoryNode.CASES, org.sleuthkit.autopsy.coordinationservice.CoordinationService.getInstance(), and org.sleuthkit.autopsy.coordinationservice.CoordinationService.tryGetSharedLock().

Referenced by org.sleuthkit.autopsy.casemodule.Case.open().

static void org.sleuthkit.autopsy.casemodule.Case.addEventSubscriber	(	Set< String >	eventNames,
		PropertyChangeListener	subscriber
	)

static

Adds a subscriber to specific case events.

Parameters

eventNames	The events the subscriber is interested in.
subscriber	The subscriber (PropertyChangeListener) to add.

Deprecated:: Use addEventTypeSubscriber instead.

Definition at line 410 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.addSubscriber().

Referenced by org.sleuthkit.autopsy.casemodule.Case.addPropertyChangeListener().

static void org.sleuthkit.autopsy.casemodule.Case.addEventSubscriber	(	String	eventName,
		PropertyChangeListener	subscriber
	)

static

Adds a subscriber to specific case events.

Parameters

eventName	The event the subscriber is interested in.
subscriber	The subscriber (PropertyChangeListener) to add.

Deprecated:: Use addEventTypeSubscriber instead.

Definition at line 435 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.addSubscriber().

static void org.sleuthkit.autopsy.casemodule.Case.addEventTypeSubscriber	(	Set< Events >	eventTypes,
		PropertyChangeListener	subscriber
	)

static

Adds a subscriber to specific case events.

Parameters

eventTypes	The events the subscriber is interested in.
subscriber	The subscriber (PropertyChangeListener) to add.

Definition at line 420 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.addSubscriber().

Image org.sleuthkit.autopsy.casemodule.Case.addImage	(	String	imgPath,
		long	imgId,
		String	timeZone
	)		throws CaseActionException

Adds an image to the current case after it has been added to the DB. Sends out event and reopens windows if needed.

Parameters

imgPath	The path of the image file.
imgId	The ID of the image.
timeZone	The time zone of the image.

Returns

Exceptions

org.sleuthkit.autopsy.casemodule.CaseActionException

Deprecated:: As of release 4.0

Definition at line 2720 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.notifyDataSourceAdded().

static void org.sleuthkit.autopsy.casemodule.Case.addPropertyChangeListener ( PropertyChangeListener listener )

static

Adds a subscriber to all case events. To subscribe to only specific events, use one of the overloads of addEventSubscriber.

Parameters

listener The subscriber (PropertyChangeListener) to add.

Definition at line 383 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.addEventSubscriber().

Referenced by org.sleuthkit.autopsy.communications.OpenCommVisualizationToolAction.OpenCommVisualizationToolAction(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.restored().

void org.sleuthkit.autopsy.casemodule.Case.addReport	(	String	localPath,
		String	srcModuleName,
		String	reportName
	)		throws TskCoreException

Adds a report to the case.

Parameters

localPath	The path of the report file, must be in the case directory or one of its subdirectories.
srcModuleName	The name of the module that created the report.
reportName	The report name, may be empty.

Exceptions

TskCoreException if there is a problem adding the report to the case database.

Definition at line 1553 of file Case.java.

Referenced by org.sleuthkit.autopsy.modules.stix.STIXReportModule.generateReport(), and org.sleuthkit.autopsy.timeline.actions.SaveSnapshotAsReport.SaveSnapshotAsReport().

Report org.sleuthkit.autopsy.casemodule.Case.addReport	(	String	localPath,
		String	srcModuleName,
		String	reportName,
		Content	parent
	)		throws TskCoreException

Adds a report to the case.

Parameters

localPath	The path of the report file, must be in the case directory or one of its subdirectories.
srcModuleName	The name of the module that created the report.
reportName	The report name, may be empty.
parent	The Content used to create the report, if available.

Returns: The new Report instance.

Exceptions

TskCoreException if there is a problem adding the report to the case database.

Definition at line 1571 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

static void org.sleuthkit.autopsy.casemodule.Case.clearTempSubDir ( String tempSubDirPath )

staticprivate

Empties the temp subdirectory for the current case.

Definition at line 1158 of file Case.java.

References org.sleuthkit.autopsy.coreutils.FileUtil.deleteDir().

Referenced by org.sleuthkit.autopsy.casemodule.Case.openServices().

void org.sleuthkit.autopsy.casemodule.Case.close ( ) throws CaseActionException

private

Closes the case.

Definition at line 2157 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.open().

void org.sleuthkit.autopsy.casemodule.Case.close ( ProgressIndicator progressIndicator )

private

Closes the case.

Parameters

progressIndicator A progress indicator.

Definition at line 2231 of file Case.java.

void org.sleuthkit.autopsy.casemodule.Case.closeAppServiceCaseResources ( )

private

Allows any registered application-level services to close any resources specific to this case.

Definition at line 2288 of file Case.java.

References org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.error(), org.sleuthkit.autopsy.progress.ProgressIndicator.finish(), org.sleuthkit.autopsy.casemodule.Case.logger, org.sleuthkit.autopsy.core.RuntimeProperties.runningWithGUI, org.sleuthkit.autopsy.coreutils.ThreadUtils.shutDownTaskExecutor(), and org.sleuthkit.autopsy.progress.ProgressIndicator.start().

Referenced by org.sleuthkit.autopsy.casemodule.Case.close().

void org.sleuthkit.autopsy.casemodule.Case.closeCase ( ) throws CaseActionException

Closes this Autopsy case.

Exceptions

CaseActionException if there is a problem closing the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Deprecated:: Use closeCurrentCase instead.

Definition at line 2591 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase().

static void org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase ( ) throws CaseActionException

static

Closes the current case.

Exceptions

CaseActionException If there is a problem closing the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 642 of file Case.java.

Referenced by org.sleuthkit.autopsy.actions.ExitAction.actionPerformed(), org.sleuthkit.autopsy.casemodule.CaseCloseAction.actionPerformed(), org.sleuthkit.autopsy.casemodule.Case.closeCase(), org.sleuthkit.autopsy.core.Installer.closing(), org.sleuthkit.autopsy.casemodule.Case.deleteCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

static String org.sleuthkit.autopsy.casemodule.Case.convertTimeZone ( String timeZoneId )

static

Converts a Java timezone id to a coded string with only alphanumeric characters. Example: "America/New_York" is converted to "EST5EDT" by this method.

Parameters

timeZoneId The time zone id.

Returns: The converted time zone string.

Deprecated:: Use org.sleuthkit.autopsy.coreutils.TimeZoneUtils.convertToAlphaNumericFormat instead.

Definition at line 2619 of file Case.java.

References org.sleuthkit.autopsy.coreutils.TimeZoneUtils.convertToAlphaNumericFormat().

static void org.sleuthkit.autopsy.casemodule.Case.create	(	String	caseDir,
		String	caseDisplayName,
		String	caseNumber,
		String	examiner
	)		throws CaseActionException

static

Creates a new, single-user Autopsy case.

Parameters

caseDir	The full path of the case directory. The directory will be created if it doesn't already exist; if it exists, it is ASSUMED it was created by calling createCaseDirectory.
caseDisplayName	The display name of case, which may be changed later by the user.
caseNumber	The case number, can be the empty string.
examiner	The examiner to associate with the case, can be the empty string.

Exceptions

CaseActionException if there is a problem creating the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Deprecated:: Use createAsCurrentCase instead.

Definition at line 2536 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.createAsCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.CaseType.SINGLE_USER_CASE.

static void org.sleuthkit.autopsy.casemodule.Case.create	(	String	caseDir,
		String	caseDisplayName,
		String	caseNumber,
		String	examiner,
		CaseType	caseType
	)		throws CaseActionException

static

Creates a new Autopsy case and makes it the current case.

Parameters

caseDir	The full path of the case directory. The directory will be created if it doesn't already exist; if it exists, it is ASSUMED it was created by calling createCaseDirectory.
caseDisplayName	The display name of case, which may be changed later by the user.
caseNumber	The case number, can be the empty string.
examiner	The examiner to associate with the case, can be the empty string.
caseType	The type of case (single-user or multi-user).

Exceptions

CaseActionException if there is a problem creating the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Deprecated:: Use createAsCurrentCase instead.

Definition at line 2561 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.createAsCurrentCase().

static void org.sleuthkit.autopsy.casemodule.Case.createAsCurrentCase	(	String	caseDir,
		String	caseDisplayName,
		String	caseNumber,
		String	examiner,
		CaseType	caseType
	)		throws CaseActionException, CaseActionCancelledException

static

Creates a new case and makes it the current case.

IMPORTANT: This method should not be called in the event dispatch thread (EDT).

Parameters

caseDir	The full path of the case directory. The directory will be created if it doesn't already exist; if it exists, it is ASSUMED it was created by calling createCaseDirectory.
caseDisplayName	The display name of case, which may be changed later by the user.
caseNumber	The case number, can be the empty string.
examiner	The examiner to associate with the case, can be the empty string.
caseType	The type of case (single-user or multi-user).

Exceptions

CaseActionException	If there is a problem creating the case.
CaseActionCancelledException	If creating the case is cancelled.

Deprecated:: use createAsCurrentCase(CaseType caseType, String caseDir, CaseDetails caseDetails) instead

Definition at line 510 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.create().

static void org.sleuthkit.autopsy.casemodule.Case.createAsCurrentCase	(	CaseType	caseType,
		String	caseDir,
		CaseDetails	caseDetails
	)		throws CaseActionException, CaseActionCancelledException

static

Creates a new case and makes it the current case.

IMPORTANT: This method should not be called in the event dispatch thread (EDT).

Parameters

caseDir	The full path of the case directory. The directory will be created if it doesn't already exist; if it exists, it is ASSUMED it was created by calling createCaseDirectory.
caseType	The type of case (single-user or multi-user).
caseDetails	Contains the modifiable details of the case such as the case display name, the case number, and the examiner related data.

Exceptions

CaseActionException	If there is a problem creating the case.
CaseActionCancelledException	If creating the case is cancelled.

Definition at line 537 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.Case(), org.sleuthkit.autopsy.casemodule.CaseDetails.getCaseDisplayName(), and org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

void org.sleuthkit.autopsy.casemodule.Case.createCaseData ( ProgressIndicator progressIndicator ) throws CaseActionException

private

Creates the case directory, case database, and case metadata file.

Parameters

progressIndicator A progress indicartor.

Exceptions

CaseActionException If there is a problem creating the case database. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 1887 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.open().

static void org.sleuthkit.autopsy.casemodule.Case.createCaseDirectory	(	String	caseDir,
		CaseType	caseType
	)		throws CaseActionException

static

Creates a case directory and its subdirectories.

Parameters

caseDir	Path to the case directory (typically base + case name).
caseType	The type of case, single-user or multi-user.

Exceptions

CaseActionException throw if could not create the case dir

Definition at line 832 of file Case.java.

References org.sleuthkit.autopsy.coreutils.NetworkUtils.getLocalHostName(), org.sleuthkit.autopsy.casemodule.Case.MODULE_FOLDER, org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE, and org.sleuthkit.autopsy.casemodule.Case.REPORTS_FOLDER.

Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseData().

static void org.sleuthkit.autopsy.casemodule.Case.deleteCase ( CaseMetadata metadata ) throws CaseActionException

static

Deletes a case. This method cannot be used to delete the current case; deleting the current case must be done by calling Case.deleteCurrentCase.

Parameters

metadata The metadata for the case to delete.

Exceptions

CaseActionException if there is a problem deleting the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 701 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteCurrentCase().

static void org.sleuthkit.autopsy.casemodule.Case.deleteCase	(	CaseMetadata	metadata,
		ProgressIndicator	progressIndicator
	)		throws CaseActionException

staticprivate

Deletes the case directory of a deleted case and removes the case form the Recent Cases menu.

Parameters

metadata	The case metadata.
progressIndicator	A progress indicator.

Exceptions

UserPreferencesException	if there is a problem getting the case databse connection info for a multi-user case.
ClassNotFoundException	if there is a problem loading the JDBC driver for PostgreSQL for a multi-user case.
SQLException	If there is a problem

Definition at line 940 of file Case.java.

static void org.sleuthkit.autopsy.casemodule.Case.deleteCurrentCase ( ) throws CaseActionException

static

Deletes the current case.

Exceptions

CaseActionException If there is a problem deleting the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 673 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseActionSerializationLock, org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.deleteCase().

void org.sleuthkit.autopsy.casemodule.Case.deleteReports ( Collection<?extends Report > reports ) throws TskCoreException

Deletes one or more reports from the case database. Does not delete the report files.

Parameters

reports The report(s) to be deleted from the case.

Exceptions

TskCoreException if there is an error deleting the report(s).

Definition at line 1608 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish(), and org.sleuthkit.autopsy.casemodule.Case.Events.REPORT_DELETED.

Referenced by org.sleuthkit.autopsy.datamodel.Reports.ReportNode.DeleteReportAction.actionPerformed(), and org.sleuthkit.autopsy.casemodule.Case.deleteReports().

void org.sleuthkit.autopsy.casemodule.Case.deleteReports	(	Collection<?extends Report >	reports,
		boolean	deleteFromDisk
	)		throws TskCoreException

Deletes reports from the case.

Parameters

reports	Collection of Report to be deleted from the case.
deleteFromDisk	No longer supported - ignored.

Exceptions

TskCoreException

Deprecated:: Use deleteReports(Collection<? extends Report> reports) instead.

Definition at line 2753 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.deleteReports().

static String org.sleuthkit.autopsy.casemodule.Case.displayNameToUniqueName ( String caseDisplayName )

staticprivate

Transforms a case display name into a unique case name that can be used to identify the case even if the display name is changed.

Parameters

caseDisplayName A case display name.

Returns: The unique case name.

Definition at line 793 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.Case().

static boolean org.sleuthkit.autopsy.casemodule.Case.existsCurrentCase ( )

static

Check if case is currently open.

Returns: True if a case is open.

Deprecated:: Use isCaseOpen instead.

Definition at line 2658 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.isCaseOpen().

List<Report> org.sleuthkit.autopsy.casemodule.Case.getAllReports ( ) throws TskCoreException

Gets the reports that have been added to the case.

Returns: A collection of report objects.

Exceptions

TskCoreException if there is a problem querying the case database.

Definition at line 1596 of file Case.java.

Referenced by org.sleuthkit.autopsy.datamodel.Reports.ReportNodeFactory.createKeys().

static String org.sleuthkit.autopsy.casemodule.Case.getAppName ( )

static

Gets the application name.

Returns: The application name.

Deprecated:

Definition at line 2512 of file Case.java.

References org.sleuthkit.autopsy.core.UserPreferences.getAppName().

static String org.sleuthkit.autopsy.casemodule.Case.getAutopsyVersion ( )

static

Gets the Autopsy version.

Returns: The Autopsy version.

Deprecated:: Use org.sleuthkit.autopsy.coreutils.Version.getVersion instead

Definition at line 2646 of file Case.java.

References org.sleuthkit.autopsy.coreutils.Version.getVersion().

String org.sleuthkit.autopsy.casemodule.Case.getCacheDirectory ( )

Gets the full path to the cache directory for this case, creating it if it does not exist.

Returns: The cache directory path.

Definition at line 1320 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory().

Referenced by org.sleuthkit.autopsy.coreutils.ImageUtils.getCachedThumbnailLocation().

String org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory ( )

Gets the path to the top-level case directory.

Returns: The top-level case directory path.

Definition at line 1278 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory().

String org.sleuthkit.autopsy.casemodule.Case.getCaseNotes ( )

Gets the case notes.

Returns: The case notes.

Definition at line 1269 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseNotes().

CaseType org.sleuthkit.autopsy.casemodule.Case.getCaseType ( )

Gets the case type.

Returns: The case type.

Definition at line 1197 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType().

Referenced by org.sleuthkit.autopsy.casemodule.Case.getModuleOutputDirectoryRelativePath(), org.sleuthkit.autopsy.ingest.IngestManager.startIngestJob(), org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.startUp(), org.sleuthkit.autopsy.ingest.IngestManager.subscribeToServiceMonitorEvents(), and org.sleuthkit.autopsy.casemodule.ImageFilePanel.validatePanel().

String org.sleuthkit.autopsy.casemodule.Case.getCreatedDate ( )

Gets the case create date.

Returns: case The case create date.

Definition at line 1206 of file Case.java.

static Case org.sleuthkit.autopsy.casemodule.Case.getCurrentCase ( )

static

Gets the current case. This method should only be called by clients that can be sure a case is currently open. Some examples of suitable clients are data source processors, ingest modules, and report modules.

Returns: The current case.

Definition at line 593 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows().

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.ingest.IngestServices.getCurrentCase(), and org.sleuthkit.autopsy.ingest.IngestServices.getCurrentSleuthkitCaseDb().

static Case org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows ( ) throws NoCurrentCaseException

static

Gets the current case, if there is one, or throws an exception if there is no current case. This method should only be called by methods known to run in threads where it is possible that another thread has closed the current case. The exception provides some protection from the consequences of the race condition between the calling thread and a case closing thread, but it is not fool-proof. Background threads calling this method should put all operations in an exception firewall with a try and catch-all block to handle the possibility of bad timing.

TODO (JIRA-3825): Introduce a reference counting scheme for this get case method.

Returns: The current case.

Exceptions

NoCurrentCaseException if there is no current case.

Definition at line 621 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.currentCase.

List<Content> org.sleuthkit.autopsy.casemodule.Case.getDataSources ( ) throws TskCoreException

Gets the data sources for the case.

Returns: A list of data sources.

Exceptions

org.sleuthkit.datamodel.TskCoreException if there is a problem querying the case database.

Definition at line 1389 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.getTimeZones(), org.sleuthkit.autopsy.casemodule.Case.hasData(), org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.propertyChange(), and org.sleuthkit.autopsy.datamodel.DataSourcesNode.DataSourcesNodeChildren.reloadKeys().

String org.sleuthkit.autopsy.casemodule.Case.getDisplayName ( )

Gets the case name that can be changed by the user.

Returns: The case display name.

Definition at line 1224 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDisplayName().

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase(), org.sleuthkit.autopsy.report.taggedhashes.AddTaggedHashesToHashDb.generateReport(), org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources(), org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase(), org.sleuthkit.autopsy.timeline.actions.SaveSnapshotAsReport.SaveSnapshotAsReport(), and org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened().

String org.sleuthkit.autopsy.casemodule.Case.getExaminer ( )

Gets the examiner name.

Returns: The examiner name.

Definition at line 1242 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getExaminer().

String org.sleuthkit.autopsy.casemodule.Case.getExaminerEmail ( )

Gets the examiner email address.

Returns: The examiner email address.

Definition at line 1260 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getExaminerEmail().

String org.sleuthkit.autopsy.casemodule.Case.getExaminerPhone ( )

Gets the examiner phone number.

Returns: The examiner phone number.

Definition at line 1251 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getExaminerPhone().

String org.sleuthkit.autopsy.casemodule.Case.getExportDirectory ( )

Gets the full path to the export directory for this case, creating it if it does not exist.

Returns: The export directory path.

Definition at line 1330 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory().

Referenced by org.sleuthkit.autopsy.directorytree.ExtractAction.extractFile(), org.sleuthkit.autopsy.directorytree.ExtractAction.extractFiles(), and org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.saveToCSV().

String org.sleuthkit.autopsy.casemodule.Case.getLogDirectoryPath ( )

Gets the full path to the log directory for this case, creating it if it does not exist.

Returns: The log directory path.

Definition at line 1340 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory().

Referenced by org.sleuthkit.autopsy.actions.OpenLogFolderAction.actionPerformed(), and org.sleuthkit.autopsy.casemodule.Case.openServices().

String org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory ( )

Gets the full path to the module output directory for this case, creating it if it does not exist.

Returns: The module output directory path.

Definition at line 1360 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory().

Referenced by org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), org.sleuthkit.autopsy.casemodule.LocalFilesDSProcessor.extractLogicalEvidenceFileContents(), org.sleuthkit.autopsy.casemodule.Case.getModuleOutputDirectoryRelativePath(), org.sleuthkit.autopsy.casemodule.Case.getModulesOutputDirAbsPath(), org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.getRAOutputPath(), and org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.startUp().

String org.sleuthkit.autopsy.casemodule.Case.getModuleOutputDirectoryRelativePath ( )

Gets the path of the module output directory for this case, relative to the case directory, creating it if it does not exist.

Returns: The path to the module output directory, relative to the case directory.

Definition at line 1371 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getCaseType(), org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory(), and org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE.

Referenced by org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction.ExtractAndIngestWorker.doInBackground(), and org.sleuthkit.autopsy.modules.embeddedfileextractor.EmbeddedFileExtractorIngestModule.startUp().

String org.sleuthkit.autopsy.casemodule.Case.getModulesOutputDirAbsPath ( )

Get module output directory path where modules should save their permanent data.

Returns: absolute path to the module output directory

Deprecated:: Use getModuleDirectory() instead.

Definition at line 2701 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory().

static String org.sleuthkit.autopsy.casemodule.Case.getModulesOutputDirRelPath ( )

static

Get relative (with respect to case dir) module output directory path where modules should save their permanent data. The directory is a subdirectory of this case dir.

Returns: relative path to the module output dir

Deprecated:: Use getModuleOutputDirectoryRelativePath() instead

Definition at line 2672 of file Case.java.

String org.sleuthkit.autopsy.casemodule.Case.getName ( )

Gets the unique and immutable case name.

Returns: The case name.

Definition at line 1215 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseName().

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase(), org.sleuthkit.autopsy.centralrepository.contentviewer.DataContentViewerOtherCases.getCorrelatedInstances(), org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources(), org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.propertyChange().

static String org.sleuthkit.autopsy.casemodule.Case.getNameForTitle ( )

staticprivate

Definition at line 1024 of file Case.java.

References org.sleuthkit.autopsy.core.UserPreferences.getAppName(), org.sleuthkit.autopsy.coreutils.Version.getName(), and org.sleuthkit.autopsy.coreutils.Version.getVersion().

Referenced by org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseClosed(), and org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened().

String org.sleuthkit.autopsy.casemodule.Case.getNumber ( )

Gets the case number.

Returns: The case number

Definition at line 1233 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseNumber().

String org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory ( String subDirectoryName )

private

Gets the path to the specified subdirectory of the case directory, creating it if it does not already exist.

Returns: The absolute path to the specified subdirectory.

Definition at line 2374 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOutputDirectory().

Referenced by org.sleuthkit.autopsy.casemodule.Case.getCacheDirectory(), org.sleuthkit.autopsy.casemodule.Case.getExportDirectory(), org.sleuthkit.autopsy.casemodule.Case.getLogDirectoryPath(), org.sleuthkit.autopsy.casemodule.Case.getModuleDirectory(), org.sleuthkit.autopsy.casemodule.Case.getReportDirectory(), and org.sleuthkit.autopsy.casemodule.Case.getTempDirectory().

String org.sleuthkit.autopsy.casemodule.Case.getOutputDirectory ( )

Gets the root case output directory for this case, creating it if it does not exist. If the case is a single-user case, this is the case directory. If the case is a multi-user case, this is a subdirectory of the case directory specific to the host machine.

Returns: the path to the host output directory.

Definition at line 1290 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType(), org.sleuthkit.autopsy.coreutils.NetworkUtils.getLocalHostName(), and org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE.

Referenced by org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory(), and org.sleuthkit.autopsy.actions.OpenOutputFolderAction.performAction().

static PropertyChangeSupport org.sleuthkit.autopsy.casemodule.Case.getPropertyChangeSupport ( )

static

Gets a PropertyChangeSupport object. The PropertyChangeSupport object returned is not used by instances of this class and does not have any PropertyChangeListeners.

Returns: A new PropertyChangeSupport object.

Deprecated:: Do not use.

Definition at line 2687 of file Case.java.

String org.sleuthkit.autopsy.casemodule.Case.getReportDirectory ( )

Gets the full path to the reports directory for this case, creating it if it does not exist.

Returns: The report directory path.

Definition at line 1350 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory().

Referenced by org.sleuthkit.autopsy.timeline.actions.SaveSnapshotAsReport.SaveSnapshotAsReport().

Services org.sleuthkit.autopsy.casemodule.Case.getServices ( )

Gets the case services manager.

Returns: The case services manager.

Definition at line 1188 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseServices.

SleuthkitCase org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase ( )

Gets the case database.

Returns: The case database.

Definition at line 1179 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseDb.

String org.sleuthkit.autopsy.casemodule.Case.getTempDirectory ( )

Gets the full path to the temp directory for this case, creating it if it does not exist.

Returns: The temp subdirectory path.

Definition at line 1310 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getOrCreateSubdirectory().

Referenced by org.sleuthkit.autopsy.directorytree.ExternalViewerAction.actionPerformed(), org.sleuthkit.autopsy.recentactivity.RAImageIngestModule.getRATempPath(), org.sleuthkit.autopsy.coreutils.VideoUtils.getVideoFileInTempDir(), and org.sleuthkit.autopsy.casemodule.Case.openServices().

String org.sleuthkit.autopsy.casemodule.Case.getTextIndexName ( )

Gets the name of the legacy keyword search index for the case. Not for general use.

Returns: The index name.

Definition at line 1422 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getTextIndexName().

Set<TimeZone> org.sleuthkit.autopsy.casemodule.Case.getTimeZone ( )

Gets the time zone(s) of the image data source(s) in this case.

Returns: The set of time zones in use.

Deprecated:: Use getTimeZones instead.

Definition at line 2738 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getTimeZones().

Set<TimeZone> org.sleuthkit.autopsy.casemodule.Case.getTimeZones ( )

Gets the time zone(s) of the image data source(s) in this case.

Returns: The set of time zones in use.

Definition at line 1400 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getDataSources().

Referenced by org.sleuthkit.autopsy.casemodule.Case.getTimeZone().

boolean org.sleuthkit.autopsy.casemodule.Case.hasData ( )

Queries whether or not the case has data, i.e., whether or not at least one data source has been added to the case.

Returns: True or false.

Definition at line 1432 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getDataSources(), and org.sleuthkit.autopsy.casemodule.Case.hasDataSources.

Referenced by org.sleuthkit.autopsy.corecomponents.DataContentTopComponent.canClose(), org.sleuthkit.autopsy.corecomponents.DataResultTopComponent.canClose(), org.sleuthkit.autopsy.corecomponents.DataResultPanel.canClose(), org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.canClose(), org.sleuthkit.autopsy.ingest.RunIngestAction.isEnabled(), org.sleuthkit.autopsy.timeline.OpenTimelineAction.showTimeline(), and org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened().

static void org.sleuthkit.autopsy.casemodule.Case.invokeStartupDialog ( )

static

Invokes the startup dialog window.

Deprecated:: Use StartupWindowProvider.getInstance().open() instead.

Definition at line 2601 of file Case.java.

References org.sleuthkit.autopsy.casemodule.StartupWindowProvider.getInstance(), and org.sleuthkit.autopsy.casemodule.StartupWindowProvider.open().

static boolean org.sleuthkit.autopsy.casemodule.Case.isCaseOpen ( )

static

Checks if a case, the current case, is open at the time it is called.

Returns: True or false.

Definition at line 582 of file Case.java.

Referenced by org.sleuthkit.autopsy.actions.OpenLogFolderAction.actionPerformed(), org.sleuthkit.autopsy.casemodule.Case.existsCurrentCase(), org.sleuthkit.autopsy.commonfilesearch.CommonFilesSearchAction.isEnabled(), org.sleuthkit.autopsy.diagnostics.PerformancePanelAction.isEnabled(), org.sleuthkit.autopsy.actions.ShowIngestProgressSnapshotAction.isEnabled(), org.sleuthkit.autopsy.timeline.OpenTimelineAction.isEnabled(), and org.sleuthkit.autopsy.actions.OpenOutputFolderAction.isEnabled().

static boolean org.sleuthkit.autopsy.casemodule.Case.isValidName ( String caseName )

static

Checks if a case display name is valid, i.e., does not include any characters that cannot be used in file names.

Parameters

caseName The candidate case name.

Returns: True or false.

Definition at line 479 of file Case.java.

void org.sleuthkit.autopsy.casemodule.Case.notifyAddingDataSource ( UUID eventId )

Notifies case event subscribers that a data source is being added to the case.

This should not be called from the event dispatch thread (EDT)

Parameters

eventId A unique identifier for the event. This UUID must be used to call notifyFailedAddingDataSource or notifyNewDataSource after the data source is added.

Definition at line 1453 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

void org.sleuthkit.autopsy.casemodule.Case.notifyBlackBoardArtifactTagAdded ( BlackboardArtifactTag newTag )

Notifies case event subscribers that an artifact tag has been added.

This should not be called from the event dispatch thread (EDT)

Parameters

newTag new BlackboardArtifactTag added

Definition at line 1527 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addBlackboardArtifactTag().

void org.sleuthkit.autopsy.casemodule.Case.notifyBlackBoardArtifactTagDeleted ( BlackboardArtifactTag deletedTag )

Notifies case event subscribers that an artifact tag has been deleted.

This should not be called from the event dispatch thread (EDT)

Parameters

deletedTag BlackboardArtifactTag deleted

Definition at line 1538 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.deleteBlackboardArtifactTag().

void org.sleuthkit.autopsy.casemodule.Case.notifyContentTagAdded ( ContentTag newTag )

Notifies case event subscribers that a content tag has been added.

This should not be called from the event dispatch thread (EDT)

Parameters

newTag new ContentTag added

Definition at line 1493 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.addContentTag().

void org.sleuthkit.autopsy.casemodule.Case.notifyContentTagDeleted ( ContentTag deletedTag )

Notifies case event subscribers that a content tag has been deleted.

This should not be called from the event dispatch thread (EDT)

Parameters

deletedTag ContentTag deleted

Definition at line 1504 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

Referenced by org.sleuthkit.autopsy.casemodule.services.TagsManager.deleteContentTag().

void org.sleuthkit.autopsy.casemodule.Case.notifyDataSourceAdded	(	Content	dataSource,
		UUID	addingDataSourceEventId
	)

Notifies case event subscribers that a data source has been added to the case database.

This should not be called from the event dispatch thread (EDT)

Parameters

dataSource	The data source.
addingDataSourceEventId	The unique identifier for the corresponding adding data source event (see notifyAddingDataSource).

Definition at line 1482 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

Referenced by org.sleuthkit.autopsy.casemodule.Case.addImage().

void org.sleuthkit.autopsy.casemodule.Case.notifyFailedAddingDataSource ( UUID addingDataSourceEventId )

Notifies case event subscribers that a data source failed to be added to the case.

This should not be called from the event dispatch thread (EDT)

Parameters

addingDataSourceEventId The unique identifier for the corresponding adding data source event (see notifyAddingDataSource).

Definition at line 1467 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish().

void org.sleuthkit.autopsy.casemodule.Case.notifyTagDefinitionChanged ( String changedTagName )

Notifies case event subscribers that a tag definition has changed.

This should not be called from the event dispatch thread (EDT)

Parameters

changedTagName the name of the tag definition which was changed

Definition at line 1515 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.publish(), and org.sleuthkit.autopsy.casemodule.Case.Events.TAG_DEFINITION_CHANGED.

void org.sleuthkit.autopsy.casemodule.Case.open ( boolean isNewCase ) throws CaseActionException

private

Opens this case by creating a task running in the same non-UI thread that will be used to close the case. If the case is a single-user case, this supports cancelling creation of the case by cancelling the task. If the case is a multi-user case, this ensures ensures that case directory lock held as long as the case is open is released in the same thread in which it was acquired, as is required by the coordination service.

Parameters

isNewCase True for a new case, false otherwise.

Exceptions

CaseActionException If there is a problem creating the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 1713 of file Case.java.

Referenced by org.sleuthkit.autopsy.actions.OpenLogFolderAction.actionPerformed(), org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase(), and org.sleuthkit.autopsy.actions.OpenOutputFolderAction.performAction().

void org.sleuthkit.autopsy.casemodule.Case.open	(	boolean	isNewCase,
		ProgressIndicator	progressIndicator
	)		throws CaseActionException

private

Opens the case database and services for this case.

Parameters

isNewCase	True for a new case, false otherwise.
progressIndicator	A progress indicator.

Exceptions

CaseActionException if there is a problem creating the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 1834 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.close(), org.sleuthkit.autopsy.casemodule.Case.createCaseData(), org.sleuthkit.autopsy.casemodule.Case.openCaseData(), and org.sleuthkit.autopsy.casemodule.Case.openServices().

static void org.sleuthkit.autopsy.casemodule.Case.open ( String caseMetadataFilePath ) throws CaseActionException

static

Opens an existing Autopsy case and makes it the current case.

Parameters

caseMetadataFilePath The path of the case metadata (.aut) file.

Exceptions

CaseActionException if there is a problem opening the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Deprecated:: Use openAsCurrentCase instead.

Definition at line 2577 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

void org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources ( ) throws CaseActionException

private

Allows any registered application-level services to open resources specific to this case.

Definition at line 2060 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.openServices().

static void org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase ( String caseMetadataFilePath ) throws CaseActionException

static

Opens an existing case and makes it the current case.

IMPORTANT: This method should not be called in the event dispatch thread (EDT).

Parameters

caseMetadataFilePath The path of the case metadata (.aut) file.

Exceptions

CaseActionException If there is a problem opening the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 564 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.Case(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType(), org.sleuthkit.autopsy.core.UserPreferences.getIsMultiUserModeEnabled(), org.sleuthkit.autopsy.casemodule.Case.metadata, and org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE.

Referenced by org.sleuthkit.autopsy.casemodule.MultiUserNode.OpenMultiUserCaseAction.actionPerformed(), org.sleuthkit.autopsy.casemodule.Case.createAsCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.open().

static void org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase	(	Case	newCurrentCase,
		boolean	isNewCase
	)		throws CaseActionException, CaseActionCancelledException

staticprivate

Opens a new or existing case as the current case.

Parameters

newCurrentCase	The case.
isNewCase	True for a new case, false otherwise.

Exceptions

CaseActionException	If there is a problem creating the case.
CaseActionCancelledException	If creating the case is cancelled.

Definition at line 753 of file Case.java.

void org.sleuthkit.autopsy.casemodule.Case.openCaseData ( ProgressIndicator progressIndicator ) throws CaseActionException

private

Opens an existing case database.

Parameters

progressIndicator A progress indicator.

Exceptions

CaseActionException if there is a problem opening the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 1948 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDatabaseName(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType(), org.sleuthkit.autopsy.core.UserPreferences.getDatabaseConnectionInfo(), org.sleuthkit.autopsy.core.UserPreferences.getIsMultiUserModeEnabled(), org.sleuthkit.autopsy.progress.ProgressIndicator.progress(), and org.sleuthkit.autopsy.casemodule.Case.CaseType.SINGLE_USER_CASE.

Referenced by org.sleuthkit.autopsy.casemodule.Case.open().

void org.sleuthkit.autopsy.casemodule.Case.openServices ( ProgressIndicator progressIndicator ) throws CaseActionException

private

Completes the case opening tasks common to both new cases and existing cases.

Parameters

progressIndicator A progress indicator.

Exceptions

CaseActionException

Definition at line 1984 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.open().

static boolean org.sleuthkit.autopsy.casemodule.Case.pathExists ( String filePath )

static

Check if file exists and is a normal file.

Parameters

filePath The file path.

Returns: True or false.

Deprecated:: Use java.io.File.exists or java.io.File.isFile instead

Definition at line 2633 of file Case.java.

void org.sleuthkit.autopsy.casemodule.Case.releaseSharedCaseDirLock ( String caseDir )

private

Releases a shared case directory lock for the current case.

Parameters

caseDir The full path of the case directory.

Definition at line 2357 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseDirLock.

Referenced by org.sleuthkit.autopsy.casemodule.Case.close(), and org.sleuthkit.autopsy.casemodule.Case.open().

static void org.sleuthkit.autopsy.casemodule.Case.removeEventSubscriber	(	String	eventName,
		PropertyChangeListener	subscriber
	)

static

Removes a subscriber to specific case events.

Parameters

eventName	The event the subscriber is no longer interested in.
subscriber	The subscriber (PropertyChangeListener) to remove.

Definition at line 445 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.removeSubscriber().

Referenced by org.sleuthkit.autopsy.casemodule.Case.removePropertyChangeListener().

static void org.sleuthkit.autopsy.casemodule.Case.removeEventSubscriber	(	Set< String >	eventNames,
		PropertyChangeListener	subscriber
	)

static

Removes a subscriber to specific case events.

Parameters

eventNames	The event the subscriber is no longer interested in.
subscriber	The subscriber (PropertyChangeListener) to remove.

Definition at line 455 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.removeSubscriber().

static void org.sleuthkit.autopsy.casemodule.Case.removeEventTypeSubscriber	(	Set< Events >	eventTypes,
		PropertyChangeListener	subscriber
	)

static

Removes a subscriber to specific case events.

Parameters

eventTypes	The events the subscriber is no longer interested in.
subscriber	The subscriber (PropertyChangeListener) to remove.

Definition at line 465 of file Case.java.

References org.sleuthkit.autopsy.events.AutopsyEventPublisher.removeSubscriber().

static void org.sleuthkit.autopsy.casemodule.Case.removePropertyChangeListener ( PropertyChangeListener listener )

static

Removes a subscriber to all case events. To remove a subscription to only specific events, use one of the overloads of removeEventSubscriber.

Parameters

listener The subscriber (PropertyChangeListener) to remove.

Definition at line 395 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.removeEventSubscriber().

Referenced by org.sleuthkit.autopsy.timeline.TimeLineController.shutDownTimeLine(), and org.sleuthkit.autopsy.centralrepository.eventlisteners.Installer.uninstalled().

static void org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseClosed ( )

staticprivate

Definition at line 1119 of file Case.java.

References org.sleuthkit.autopsy.coreutils.MessageNotifyUtil.Notify.clear(), org.sleuthkit.autopsy.corecomponentinterfaces.CoreComponentControl.closeCoreWindows(), org.sleuthkit.autopsy.casemodule.Case.getNameForTitle(), and org.sleuthkit.autopsy.core.RuntimeProperties.runningWithGUI.

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase().

static void org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened ( Case newCurrentCase )

staticprivate

Update the GUI to to reflect the current case.

Definition at line 1037 of file Case.java.

References org.sleuthkit.autopsy.coreutils.DriveUtils.driveExists(), org.sleuthkit.autopsy.casemodule.Case.getDisplayName(), org.sleuthkit.autopsy.casemodule.Case.getNameForTitle(), org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase(), org.sleuthkit.autopsy.casemodule.Case.hasData(), org.sleuthkit.autopsy.corecomponentinterfaces.CoreComponentControl.openCoreWindows(), and org.sleuthkit.autopsy.core.RuntimeProperties.runningWithGUI.

Referenced by org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

Member Data Documentation

final String org.sleuthkit.autopsy.casemodule.Case.CACHE_FOLDER = "Cache"

staticprivate

Definition at line 128 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.CASE_ACTION_THREAD_NAME = "%s-case-action"

staticprivate

Definition at line 134 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.CASE_RESOURCES_THREAD_NAME = "%s-manage-case-resources"

staticprivate

Definition at line 135 of file Case.java.

final Object org.sleuthkit.autopsy.casemodule.Case.caseActionSerializationLock = new Object()

staticprivate

Definition at line 138 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase(), org.sleuthkit.autopsy.casemodule.Case.deleteCase(), org.sleuthkit.autopsy.casemodule.Case.deleteCurrentCase(), and org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

SleuthkitCase org.sleuthkit.autopsy.casemodule.Case.caseDb

private

Definition at line 144 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

CoordinationService.Lock org.sleuthkit.autopsy.casemodule.Case.caseDirLock

private

Definition at line 143 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.acquireSharedCaseDirLock(), and org.sleuthkit.autopsy.casemodule.Case.releaseSharedCaseDirLock().

volatile ExecutorService org.sleuthkit.autopsy.casemodule.Case.caseLockingExecutor

private

Definition at line 142 of file Case.java.

Services org.sleuthkit.autopsy.casemodule.Case.caseServices

private

Definition at line 146 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.getServices().

CollaborationMonitor org.sleuthkit.autopsy.casemodule.Case.collaborationMonitor

private

Definition at line 145 of file Case.java.

volatile Case org.sleuthkit.autopsy.casemodule.Case.currentCase

staticprivate

Definition at line 140 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeCurrentCase(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

final int org.sleuthkit.autopsy.casemodule.Case.DIR_LOCK_TIMOUT_HOURS = 12

staticprivate

Definition at line 124 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.EVENT_CHANNEL_NAME = "%s-Case-Events"

staticprivate

Definition at line 127 of file Case.java.

final AutopsyEventPublisher org.sleuthkit.autopsy.casemodule.Case.eventPublisher = new AutopsyEventPublisher()

staticprivate

Definition at line 137 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.EXPORT_FOLDER = "Export"

staticprivate

Definition at line 129 of file Case.java.

boolean org.sleuthkit.autopsy.casemodule.Case.hasDataSources

private

Definition at line 147 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.hasData().

final String org.sleuthkit.autopsy.casemodule.Case.LOG_FOLDER = "Log"

staticprivate

Definition at line 130 of file Case.java.

final Logger org.sleuthkit.autopsy.casemodule.Case.logger = Logger.getLogger(Case.class.getName())

staticprivate

Definition at line 136 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.closeAppServiceCaseResources(), and org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources().

volatile Frame org.sleuthkit.autopsy.casemodule.Case.mainFrame

staticprivate

Definition at line 139 of file Case.java.

final CaseMetadata org.sleuthkit.autopsy.casemodule.Case.metadata

private

Definition at line 141 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.openAsCurrentCase().

final String org.sleuthkit.autopsy.casemodule.Case.MODULE_FOLDER = "ModuleOutput"

staticprivate

Definition at line 133 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseDirectory().

final String org.sleuthkit.autopsy.casemodule.Case.REPORTS_FOLDER = "Reports"

staticprivate

Definition at line 131 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseDirectory().

final int org.sleuthkit.autopsy.casemodule.Case.RESOURCES_LOCK_TIMOUT_HOURS = 12

staticprivate

Definition at line 125 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.SINGLE_USER_CASE_DB_NAME = "autopsy.db"

staticprivate

Definition at line 126 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseData().

final String org.sleuthkit.autopsy.casemodule.Case.TEMP_FOLDER = "Temp"

staticprivate

Definition at line 132 of file Case.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/casemodule/Case.java

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation