Classes
class	BackgroundOpenFileSystemsTask

class	CancelButtonListener

interface	CaseAction

enum	CaseLockType

enum	CaseType

enum	Events

class	SleuthkitEventListener

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

SleuthkitCase	createPortableCase (String caseName, File portableCaseFolder) throws TskCoreException

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	getConfigDirectory ()

String	getCreatedDate ()

List< Content >	getDataSources () throws TskCoreException

String	getDisplayName ()

String	getExaminer ()

String	getExaminerEmail ()

String	getExaminerPhone ()

String	getExportDirectory ()

String	getLogDirectoryPath ()

CaseMetadata	getMetadata ()

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 ()

boolean	hasDataSource ()

void	notifyAddingDataSource (UUID eventId)

void	notifyBlackBoardArtifactTagAdded (BlackboardArtifactTag newTag)

void	notifyBlackBoardArtifactTagAdded (BlackboardArtifactTag newTag, List< BlackboardArtifactTag > removedTagList)

void	notifyBlackBoardArtifactTagDeleted (BlackboardArtifactTag deletedTag)

void	notifyCentralRepoCommentChanged (long contentId, String newComment)

void	notifyContentTagAdded (ContentTag newTag)

void	notifyContentTagAdded (ContentTag newTag, List< ContentTag > deletedTagList)

void	notifyContentTagDeleted (ContentTag deletedTag)

void	notifyDataSourceAdded (Content dataSource, UUID addingDataSourceEventId)

void	notifyDataSourceNameChanged (Content dataSource, String newName)

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 caseDirPath, CaseType caseType) throws CaseActionException

static void	deleteCase (CaseMetadata metadata) throws CaseActionException

static void	deleteCurrentCase () throws CaseActionException

static boolean	deleteMultiUserCase (CaseNodeData caseNodeData, CaseMetadata metadata, ProgressIndicator progressIndicator, Logger logger) throws InterruptedException

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	acquireCaseLock (CaseLockType lockType) throws CaseActionException

void	close (ProgressIndicator progressIndicator)

void	closeAppServiceCaseResources ()

Void	create (ProgressIndicator progressIndicator, Object additionalParams) throws CaseActionException

void	createCaseDatabase (ProgressIndicator progressIndicator) throws CaseActionException

void	createCaseDirectoryIfDoesNotExist (ProgressIndicator progressIndicator) throws CaseActionException

void	createCaseNodeData (ProgressIndicator progressIndicator) throws CaseActionException

boolean	dbHasData () throws TskCoreException

boolean	dbHasDataSource () throws TskCoreException

void	deleteTempfilesFromCaseDirectory (ProgressIndicator progressIndicator)

void	doCloseCaseAction () throws CaseActionException

void	doOpenCaseAction (String progressIndicatorTitle, CaseAction< ProgressIndicator, Object, Void > caseAction, CaseLockType caseLockType, boolean allowCancellation, Object additionalParams) throws CaseActionException

Path	getBaseSystemTempPath ()

String	getOrCreateSubdirectory (String subDirectoryName)

Void	open (ProgressIndicator progressIndicator, Object additionalParams) throws CaseActionException

void	openAppServiceCaseResources (ProgressIndicator progressIndicator, boolean isNewCase) throws CaseActionException

void	openCaseDataBase (ProgressIndicator progressIndicator) throws CaseActionException

void	openCaseLevelServices (ProgressIndicator progressIndicator)

void	openCommunicationChannels (ProgressIndicator progressIndicator) throws CaseActionException

void	openFileSystemsInBackground ()

void	releaseCaseLock ()

void	saveCaseMetadataToFile (ProgressIndicator progressIndicator) throws CaseActionException

void	switchLoggingToCaseLogsDirectory (ProgressIndicator progressIndicator)

void	updateCaseNodeData (ProgressIndicator progressIndicator) throws CaseActionException

void	updateDataParameters () throws TskCoreException

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

static void	checkForCancellation () throws CaseActionCancelledException

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

static void	deleteFromRecentCases (CaseMetadata metadata, ProgressIndicator progressIndicator)

static void	deleteMultiUserCase (CaseMetadata metadata, ProgressIndicator progressIndicator) throws CaseActionException, InterruptedException

static void	deleteMultiUserCaseDatabase (CaseNodeData caseNodeData, CaseMetadata metadata, ProgressIndicator progressIndicator, Logger logger) throws UserPreferencesException, ClassNotFoundException, SQLException, InterruptedException

static void	deleteMultiUserCaseDirectory (CaseNodeData caseNodeData, CaseMetadata metadata, ProgressIndicator progressIndicator, Logger logger) throws CaseActionException, InterruptedException

static void	deleteMultiUserCaseTextIndex (CaseNodeData caseNodeData, CaseMetadata metadata, ProgressIndicator progressIndicator, Logger logger) throws KeywordSearchServiceException, InterruptedException

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

static void	deleteTextIndex (CaseMetadata metadata, ProgressIndicator progressIndicator) throws KeywordSearchServiceException

static String	displayNameToUniqueName (String caseDisplayName)

static String	getNameForTitle ()

static boolean	isNoNodeException (CoordinationServiceException ex)

static ContentStreamProvider	loadContentProvider (String providerName)

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

static void	setDeletedItemFlag (CaseNodeData caseNodeData, CaseNodeData.DeletedFlags flag) throws InterruptedException

static void	updateGUIForCaseClosed ()

static void	updateGUIForCaseOpened (Case newCurrentCase)

Private Attributes
volatile ExecutorService	caseActionExecutor

SleuthkitCase	caseDb

CoordinationService.Lock	caseLock

Services	caseServices

CollaborationMonitor	collaborationMonitor

volatile boolean	hasData = false

volatile boolean	hasDataSource = false

final CaseMetadata	metadata

final SleuthkitEventListener	sleuthkitEventListener

Static Private Attributes
static final String	APP_NAME = UserPreferences.getAppName()

static Future<?>	backgroundOpenFileSystemsFuture = null

static final String	CACHE_FOLDER = "Cache"

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

static final int	CASE_LOCK_TIMEOUT_MINS = 1

static final int	CASE_RESOURCES_LOCK_TIMEOUT_HOURS = 1

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

static final Object	caseActionSerializationLock = new Object()

static final String	CONFIG_FOLDER = "Config"

static volatile Case	currentCase

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	NO_NODE_ERROR_MSG_FRAGMENT = "KeeperErrorCode = NoNode"

static final ExecutorService	openFileSystemsExecutor = Executors.newSingleThreadExecutor(new ThreadFactoryBuilder().setNameFormat("case-open-file-systems-%d").build())

static final String	REPORTS_FOLDER = "Reports"

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 163 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 2061 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 2070 of file Case.java.

Member Function Documentation

void org.sleuthkit.autopsy.casemodule.Case.acquireCaseLock ( CaseLockType lockType ) throws CaseActionException

private

Acquires a case (case directory) lock for the current case.

Exceptions

CaseActionException If the lock cannot be acquired.

Definition at line 3149 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseLock, org.sleuthkit.autopsy.coordinationservice.CoordinationService.CategoryNode.CASES, org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.getInstance(), org.sleuthkit.autopsy.casemodule.Case.CaseLockType.SHARED, org.sleuthkit.autopsy.coordinationservice.CoordinationService.tryGetExclusiveLock(), and org.sleuthkit.autopsy.coordinationservice.CoordinationService.tryGetSharedLock().

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

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

staticprivate

Acquires an exclusive case resources lock.

Parameters

caseDir The full path of the case directory.

Returns: The lock or null if the lock could not be acquired.

Exceptions

CaseActionException with a user-friendly message if the lock cannot be acquired due to an exception.

Definition at line 1255 of file Case.java.

References org.sleuthkit.autopsy.coordinationservice.CoordinationService.CategoryNode.CASES, org.sleuthkit.autopsy.casemodule.multiusercases.CoordinationServiceUtils.getCaseResourcesNodePath(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.getInstance(), and org.sleuthkit.autopsy.coordinationservice.CoordinationService.tryGetExclusiveLock().

Referenced by org.sleuthkit.autopsy.casemodule.Case.doCloseCaseAction(), and org.sleuthkit.autopsy.casemodule.Case.doOpenCaseAction().

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 694 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 719 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 704 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 4001 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 667 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.communications.OpenCommVisualizationToolAction.OpenCommVisualizationToolAction(), and org.sleuthkit.autopsy.geolocation.OpenGeolocationAction.OpenGeolocationAction().

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 1919 of file Case.java.

Referenced by org.sleuthkit.autopsy.modules.leappanalyzers.ALeappAnalyzerIngestModule.addALeappReportToReports(), org.sleuthkit.autopsy.modules.leappanalyzers.ILeappAnalyzerIngestModule.addILeappReportToReports(), org.sleuthkit.autopsy.timeline.actions.SaveSnapshotAsReport.createReport(), org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport(), org.sleuthkit.autopsy.report.modules.kml.KMLReport.generateReport(), org.sleuthkit.autopsy.communications.VisualizationPanel.handleSnapshotEvent(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeIndex().

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 1937 of file Case.java.

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

static void org.sleuthkit.autopsy.casemodule.Case.checkForCancellation ( ) throws CaseActionCancelledException

staticprivate

Checks current thread for an interrupt. Usage: checking for user cancellation of a case creation/opening operation, as reflected in the exception message.

Exceptions

CaseActionCancelledException If the current thread is interrupted, assumes interrupt was due to a user action.

Definition at line 2532 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.create(), org.sleuthkit.autopsy.casemodule.Case.open(), org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources(), and org.sleuthkit.autopsy.casemodule.Case.openCommunicationChannels().

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

private

Closes the case.

Parameters

progressIndicator A progress indicator.

Delete files from temp directory if any exist.

Definition at line 3044 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.create(), org.sleuthkit.autopsy.casemodule.Case.doCloseCaseAction(), org.sleuthkit.autopsy.casemodule.Case.open(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.refresh().

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 3095 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 3872 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 927 of file Case.java.

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 3900 of file Case.java.

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

Void org.sleuthkit.autopsy.casemodule.Case.create	(	ProgressIndicator	progressIndicator,
		Object	additionalParams
	)		throws CaseActionException

private

A case action (interface CaseAction<T, V, R>) that creates the case directory and case database and opens the application services for this case.

Parameters

progressIndicator	A progress indicator.
additionalParams	An Object that holds any additional parameters for a case action. For this action, this is null.

Exceptions

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

Definition at line 2213 of file Case.java.

Referenced by org.sleuthkit.autopsy.report.modules.caseuco.CaseUcoReportModule.generateReport().

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 3817 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 3842 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 794 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.create(), org.sleuthkit.autopsy.testutils.CaseUtils.createAsCurrentCase(), and org.sleuthkit.autopsy.integrationtesting.IntegrationTestService.createCaseWithDataSources().

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 821 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.createCaseDatabase ( ProgressIndicator progressIndicator ) throws CaseActionException

private

Creates the node data for the case directory lock coordination service node, the case directory, the case database and the case metadata file.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2688 of file Case.java.

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

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

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

static

Creates a case directory and its subdirectories.

Parameters

caseDirPath	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 1163 of file Case.java.

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

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

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

private

Creates the case directory, if it does not already exist.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2551 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.createCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

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

private

Creates the node data for the case directory lock coordination service node.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2616 of file Case.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.createCaseNodeData(), org.sleuthkit.autopsy.casemodule.Case.getCaseType(), org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE, and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

SleuthkitCase org.sleuthkit.autopsy.casemodule.Case.createPortableCase	(	String	caseName,
		File	portableCaseFolder
	)		throws TskCoreException

Create an empty portable case from the current case

Parameters

caseName	Case name
portableCaseFolder	Case folder - must not exist

Returns: The portable case database

Exceptions

TskCoreException

Definition at line 2496 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getCaseNotes(), org.sleuthkit.autopsy.casemodule.Case.getExaminer(), org.sleuthkit.autopsy.casemodule.Case.getExaminerEmail(), org.sleuthkit.autopsy.casemodule.Case.getExaminerPhone(), org.sleuthkit.autopsy.casemodule.Case.getNumber(), org.sleuthkit.autopsy.casemodule.Case.metadata, org.sleuthkit.autopsy.casemodule.Case.CaseType.SINGLE_USER_CASE, and org.sleuthkit.autopsy.casemodule.Case.SINGLE_USER_CASE_DB_NAME.

Referenced by org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.createCase().

boolean org.sleuthkit.autopsy.casemodule.Case.dbHasData ( ) throws TskCoreException

private

Returns true if the case has data. A case has data if there is at least one row in either the tsk_objects or tsk_hosts table.

Returns: True if there is data in this case.

Exceptions

TskCoreException

Definition at line 3611 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteReports(), org.sleuthkit.autopsy.casemodule.Case.SleuthkitEventListener.publishHostsDeletedEvent(), org.sleuthkit.autopsy.casemodule.Case.SleuthkitEventListener.publishOsAccountDeletedEvent(), and org.sleuthkit.autopsy.casemodule.Case.updateDataParameters().

boolean org.sleuthkit.autopsy.casemodule.Case.dbHasDataSource ( ) throws TskCoreException

private

Returns true of there are any data sources in the case database.

Returns: True if this case as a data source.

Exceptions

TskCoreException

Definition at line 3589 of file Case.java.

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

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

static

Deletes a case. The case to be deleted must not be the "current case." Deleting the current case must be done by calling Case.deleteCurrentCase.

Parameters

metadata The case metadata.

Exceptions

CaseActionException If there were one or more errors deleting the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 1025 of file Case.java.

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

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

staticprivate

Attempts to delete the case directory for a case.

Parameters

metadata	The case metadata.
progressIndicator	A progress indicator.

Exceptions

CaseActionException If there is an error deleting the case directory.

Definition at line 3495 of file Case.java.

References org.sleuthkit.autopsy.coreutils.FileUtil.deleteDir(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDirectory(), and org.sleuthkit.autopsy.casemodule.Case.deleteSingleUserCase().

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 958 of file Case.java.

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

static void org.sleuthkit.autopsy.casemodule.Case.deleteFromRecentCases	(	CaseMetadata	metadata,
		ProgressIndicator	progressIndicator
	)

staticprivate

Attempts to remove a case from the recent cases menu if the main application window is present.

Parameters

metadata	The case metadata.
progressIndicator	A progress indicator.

Definition at line 3512 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDisplayName(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getFilePath(), org.sleuthkit.autopsy.progress.ProgressIndicator.progress(), and org.sleuthkit.autopsy.core.RuntimeProperties.runningWithGUI.

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), and org.sleuthkit.autopsy.casemodule.Case.deleteSingleUserCase().

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

staticprivate

Deletes a multi-user case. This method does so after acquiring the case directory coordination service lock and is intended to be used for deleting simple multi-user cases without auto ingest input. Note that the case directory coordination service node for the case is only deleted if no errors occurred.

Parameters

metadata	The case metadata.
progressIndicator	A progress indicator.

Exceptions

CaseActionException	If there were one or more errors deleting the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.
InterruptedException	If the thread this code is running in is interrupted while blocked, i.e., if cancellation of the operation is detected during a wait.

Definition at line 3267 of file Case.java.

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

static boolean org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase	(	CaseNodeData	caseNodeData,
		CaseMetadata	metadata,
		ProgressIndicator	progressIndicator,
		Logger	logger
	)		throws InterruptedException

static

IMPORTANT: This is a "beta" method and is subject to change or removal without notice!

Deletes a mulit-user case by attempting to delete the case database, the text index, the case directory, and the case resources coordination service node for a case, and removes the case from the recent cases menu of the main application window. Callers of this method MUST acquire and release the case directory lock for the case and are responsible for deleting the corresponding coordination service nodes, if desired.

Parameters

caseNodeData	The coordination service node data for the case.
metadata	The case metadata.
progressIndicator	A progress indicator.
logger	A logger.

Returns: True if one or more errors occurred (see log for details), false otherwise.

Exceptions

InterruptedException If the thread this code is running in is interrupted while blocked, i.e., if cancellation of the operation is detected during a wait.

Definition at line 3354 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.deleteFromRecentCases(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseTextIndex(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDisplayName(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseName().

static void org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase	(	CaseNodeData	caseNodeData,
		CaseMetadata	metadata,
		ProgressIndicator	progressIndicator,
		Logger	logger
	)		throws UserPreferencesException, ClassNotFoundException, SQLException, InterruptedException

staticprivate

Attempts to delete the case database for a multi-user case.

Parameters

caseNodeData	The coordination service node data for the case.
metadata	The case metadata.
progressIndicator	A progress indicator.
logger	A logger.

Exceptions

UserPreferencesException	if there is an error getting the database server connection info.
ClassNotFoundException	if there is an error gettting the required JDBC driver.
SQLException	if there is an error executing the SQL to drop the database from the database server.
InterruptedException	If interrupted while blocked waiting for coordination service data to be written to the coordination service node database.

Definition at line 3397 of file Case.java.

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

static void org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDirectory	(	CaseNodeData	caseNodeData,
		CaseMetadata	metadata,
		ProgressIndicator	progressIndicator,
		Logger	logger
	)		throws CaseActionException, InterruptedException

staticprivate

Attempts to delete the case directory for a multi-user case.

Parameters

caseNodeData	The coordination service node data for the case.
metadata	The case metadata.
progressIndicator	A progress indicator.
logger	A logger.

Exceptions

CaseActionException	if there is an error deleting the case directory.
InterruptedException	If interrupted while blocked waiting for coordination service data to be written to the coordination service node database.

Definition at line 3475 of file Case.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.DeletedFlags.CASE_DIR, org.sleuthkit.autopsy.casemodule.Case.deleteCaseDirectory(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDirectory(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDisplayName(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getName(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.isDeletedFlagSet(), and org.sleuthkit.autopsy.casemodule.Case.setDeletedItemFlag().

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

static void org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseTextIndex	(	CaseNodeData	caseNodeData,
		CaseMetadata	metadata,
		ProgressIndicator	progressIndicator,
		Logger	logger
	)		throws KeywordSearchServiceException, InterruptedException

staticprivate

Attempts to delete the text index for a multi-user case.

Parameters

caseNodeData	The coordination service node data for the case.
metadata	The case metadata.
progressIndicator	A progress indicator.
logger	A logger.

Exceptions

KeywordSearchServiceException	If there is an error deleting the text index.
InterruptedException	If interrupted while blocked waiting for coordination service data to be written to the coordination service node database.

Definition at line 3432 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.deleteTextIndex(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDirectory(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDisplayName(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getName(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.isDeletedFlagSet(), org.sleuthkit.autopsy.casemodule.Case.setDeletedItemFlag(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.DeletedFlags.TEXT_INDEX.

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

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 1976 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.dbHasData(), 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 4034 of file Case.java.

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

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

staticprivate

Deletes a single-user case.

Parameters

metadata	The case metadata.
progressIndicator	A progress indicator.

Exceptions

CaseActionException If there were one or more errors deleting the case. The exception will have a user-friendly message and may be a wrapper for a lower-level exception.

Definition at line 3215 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.deleteCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.deleteFromRecentCases(), org.sleuthkit.autopsy.casemodule.Case.deleteTextIndex(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDisplayName(), and org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseName().

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

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

private

Deletes any files in the temp subdirectory of the case directory.

Parameters

progressIndicator A progress indicator.

Definition at line 2663 of file Case.java.

References org.sleuthkit.autopsy.coreutils.FileUtil.deleteDir(), org.sleuthkit.autopsy.casemodule.Case.getTempDirectory(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

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

staticprivate

Attempts to delete the text index for a case.

Parameters

metadata	The case metadata.
progressIndicator	A progress indicator.

Exceptions

KeywordSearchServiceException If there is an error deleting the text index.

Definition at line 3452 of file Case.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseTextIndex(), and org.sleuthkit.autopsy.casemodule.Case.deleteSingleUserCase().

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 1123 of file Case.java.

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

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

private

Performs a case action that involves closing a case opened by calling doOpenCaseAction. If the case is a multi-user case, the coordination service case lock acquired by the call to doOpenCaseAction is released. This case lock must be released in the same thread in which it was acquired, as required by the coordination service. The single-threaded executor saved during the case opening action is therefore used to do the case closing action.

Exceptions

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

Definition at line 2969 of file Case.java.

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

void org.sleuthkit.autopsy.casemodule.Case.doOpenCaseAction	(	String	progressIndicatorTitle,
		CaseAction< ProgressIndicator, Object, Void >	caseAction,
		CaseLockType	caseLockType,
		boolean	allowCancellation,
		Object	additionalParams
	)		throws CaseActionException

private

Performs a case action that involves creating or opening a case. If the case is a multi-user case, the action is done after acquiring a coordination service case lock. This case lock must be released in the same thread in which it was acquired, as required by the coordination service. A single-threaded executor is therefore created to do the case opening action, and is saved for an eventual case closing action.

IMPORTANT: If an open case action for a multi-user case is terminated because an exception is thrown or the action is cancelled, the action is responsible for releasing the case lock while still running in the case action executor's thread. This method assumes this has been done and performs an orderly shut down of the case action executor.

Parameters

progressIndicatorTitle	A title for the progress indicator for the case action.
caseAction	The case action method.
caseLockType	The type of case lock required for the case action.
allowCancellation	Whether or not to allow the action to be cancelled.
additionalParams	An Object that holds any additional parameters for a case action.

Exceptions

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

Definition at line 2111 of file Case.java.

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

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 3939 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 1964 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 3793 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 3927 of file Case.java.

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

Path org.sleuthkit.autopsy.casemodule.Case.getBaseSystemTempPath ( )

private

Returns: A subdirectory of java.io.tmpdir.

Definition at line 1559 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.APP_NAME, and org.sleuthkit.autopsy.casemodule.Case.getName().

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

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 1617 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 1530 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 1521 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.Case.createPortableCase(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryCaseDetails().

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

Gets the case type.

Returns: The case type.

Definition at line 1449 of file Case.java.

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

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

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

Returns: The config directory path.

Definition at line 1657 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.CasePreferences.loadFromStorage(), and org.sleuthkit.autopsy.casemodule.CasePreferences.saveToStorage().

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

Gets the case create date.

Returns: case The case create date.

Definition at line 1458 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.contentviewer.OtherOccurrencesPanel.getCaseCreatedDate().

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 877 of file Case.java.

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

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.

Returns: The current case.

Exceptions

NoCurrentCaseException if there is no current case.

Definition at line 902 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, possibly empty.

Exceptions

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

Definition at line 1696 of file Case.java.

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 1476 of file Case.java.

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

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

Gets the examiner name.

Returns: The examiner name.

Definition at line 1494 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.Case.createPortableCase(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryCaseDetails().

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

Gets the examiner email address.

Returns: The examiner email address.

Definition at line 1512 of file Case.java.

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

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

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

Gets the examiner phone number.

Returns: The examiner phone number.

Definition at line 1503 of file Case.java.

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

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

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 1627 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.directorytree.actionhelpers.ExtractActionHelper.getExportDirectory(), org.sleuthkit.autopsy.directorytree.ExportCSVAction.getExportDirectory(), org.sleuthkit.autopsy.centralrepository.contentviewer.OtherOccurrencesPanel.saveToCSV(), org.sleuthkit.autopsy.directorytree.actionhelpers.ExtractActionHelper.updateExportDirectory(), and org.sleuthkit.autopsy.directorytree.ExportCSVAction.updateExportDirectory().

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 1637 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.actions.OpenLogFolderAction.actionPerformed(), org.sleuthkit.autopsy.actions.ThreadDumpAction.ThreadDumper.createFilePath(), and org.sleuthkit.autopsy.casemodule.Case.switchLoggingToCaseLogsDirectory().

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

Gets the case metadata.

Returns: A CaseMetaData object.

Definition at line 1997 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.metadata.

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteCurrentCase(), org.sleuthkit.autopsy.casemodule.DeleteDataSourceAction.DataSourceDeletionWorker.doInBackground(), org.sleuthkit.autopsy.casemodule.Case.getTextIndexName(), org.sleuthkit.autopsy.apputils.ResetWindowsAction.performAction(), org.sleuthkit.autopsy.casemodule.Case.releaseCaseLock(), and org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened().

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 1667 of file Case.java.

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

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 1678 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 3982 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 3953 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 1467 of file Case.java.

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

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

staticprivate

Definition at line 1268 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 1485 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.Case.createPortableCase(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryCaseDetails().

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 3192 of file Case.java.

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

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

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 1542 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 3968 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 1647 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.timeline.actions.SaveSnapshotAsReport.createReport(), org.sleuthkit.autopsy.communications.VisualizationPanel.createReport(), org.sleuthkit.autopsy.geolocation.GeolocationTopComponent.createReportDirectory(), org.sleuthkit.autopsy.report.infrastructure.ReportGenerator.createReportDirectory(), and org.sleuthkit.autopsy.communications.VisualizationPanel.handleSnapshotEvent().

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

Gets the case services manager.

Returns: The case services manager.

Definition at line 1440 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 1431 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 1569 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getBaseSystemTempPath(), org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.getCaseType(), org.sleuthkit.autopsy.machinesettings.UserMachinePreferences.getCustomTempDirectory(), org.sleuthkit.autopsy.coreutils.NetworkUtils.getLocalHostName(), org.sleuthkit.autopsy.casemodule.Case.getName(), org.sleuthkit.autopsy.machinesettings.UserMachinePreferences.getTempDirChoice(), org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE, and org.sleuthkit.autopsy.casemodule.Case.TEMP_FOLDER.

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 1728 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getMetadata(), and 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 4019 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 1705 of file Case.java.

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

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

Returns true if there is any data in the case.

Returns: True or false.

Definition at line 1737 of file Case.java.

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

Returns true if there is one or more data sources in the case.

Returns: True or false.

Definition at line 1746 of file Case.java.

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

static

Invokes the startup dialog window.

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

Definition at line 3882 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 866 of file Case.java.

static boolean org.sleuthkit.autopsy.casemodule.Case.isNoNodeException ( CoordinationServiceException ex )

staticprivate

Examines a coordination service exception to try to determine if it is a "no node" exception, i.e., an operation was attempted on a node that does not exist.

Parameters

ex	A coordination service exception.

Returns: True or false.

Definition at line 3530 of file Case.java.

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

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 763 of file Case.java.

static ContentStreamProvider org.sleuthkit.autopsy.casemodule.Case.loadContentProvider ( String providerName )

staticprivate

Attempts to load a content provider for the provided arguments. Returns null if no content provider for the arguments can be identified.

Parameters

providerName	The name of the content provider.
args	The arguments.

Returns: The content provider or null if no content provider can be provisioned for the arguments

Definition at line 2773 of file Case.java.

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

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 1760 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.testutils.IngestUtils.addDataSource(), and org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager.JobProcessingTask.runDataSourceProcessor().

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 1880 of file Case.java.

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

void org.sleuthkit.autopsy.casemodule.Case.notifyBlackBoardArtifactTagAdded	(	BlackboardArtifactTag	newTag,
		List< BlackboardArtifactTag >	removedTagList
	)

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

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

Parameters

newTag	The added ContentTag.
removedTagList	List of ContentTags that were removed as a result of the addition of newTag.

Definition at line 1893 of file Case.java.

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

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 1904 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.notifyCentralRepoCommentChanged	(	long	contentId,
		String	newComment
	)

Notifies case event subscribers that a central repository comment has been changed.

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

Parameters

contentId	the objectId for the Content which has had its central repo comment changed
newComment	the new value of the comment

Definition at line 1865 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.centralrepository.AddEditCentralRepoCommentAction.actionPerformed().

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 1815 of file Case.java.

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

void org.sleuthkit.autopsy.casemodule.Case.notifyContentTagAdded	(	ContentTag	newTag,
		List< ContentTag >	deletedTagList
	)

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

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

Parameters

newTag	The added ContentTag.
deletedTagList	List of ContentTags that were removed as a result of the addition of newTag.

Definition at line 1828 of file Case.java.

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

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 1839 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 1791 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.testutils.IngestUtils.addDataSource(), org.sleuthkit.autopsy.casemodule.Case.addImage(), and org.sleuthkit.autopsy.datasourceprocessors.AddDataSourceCallback.done().

void org.sleuthkit.autopsy.casemodule.Case.notifyDataSourceNameChanged	(	Content	dataSource,
		String	newName
	)

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.
newName	The new name for the data source

Definition at line 1804 of file Case.java.

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

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 1776 of file Case.java.

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

Referenced by org.sleuthkit.autopsy.datasourceprocessors.AddDataSourceCallback.done().

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 1850 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	(	ProgressIndicator	progressIndicator,
		Object	additionalParams
	)		throws CaseActionException

private

A case action (interface CaseAction<T, V, R>) that opens the case database and application services for this case.

Parameters

progressIndicator	A progress indicator.
additionalParams	An Object that holds any additional parameters for a case action. For this action, this is null.

Exceptions

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

Definition at line 2265 of file Case.java.

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

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 3858 of file Case.java.

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

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

private

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

Parameters

progressIndicator	A progress indicator.
isNewCase	True if case is new

Exceptions

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

Definition at line 2830 of file Case.java.

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

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 848 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.Case.createAsCurrentCase(), org.sleuthkit.autopsy.casemodule.DeleteDataSourceAction.CaseReopeningWorker.doInBackground(), org.sleuthkit.autopsy.casemodule.UnpackagePortableCaseProgressDialog.UnpackageWorker.doInBackground(), org.sleuthkit.autopsy.casemodule.StartupWindowProvider.init(), 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 1074 of file Case.java.

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

private

Updates the node data for an existing case directory lock coordination service node and opens an existing case database.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2734 of file Case.java.

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

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

private

Opens the case-level services: the files manager, tags manager and blackboard.

Parameters

progressIndicator A progress indicator.

Definition at line 2801 of file Case.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

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

private

If this case is a multi-user case, sets up for communication with other application nodes.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2940 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.checkForCancellation(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseName(), org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseType(), org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE, org.sleuthkit.autopsy.events.AutopsyEventPublisher.openRemoteEventChannel(), and org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

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

private

Starts a background task that reads a sector from each file system of each image of a case to do an eager open of the filesystems in the case. If this method is called before another background file system read has finished the earlier one will be cancelled.

Exceptions

CaseActionCancelledException Exception thrown if task is cancelled.

Definition at line 2315 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.openFileSystemsExecutor.

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 3914 of file Case.java.

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

private

Releases a case (case directory) lock for the current case.

Definition at line 3175 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.caseLock, org.sleuthkit.autopsy.casemodule.Case.getCaseDirectory(), and org.sleuthkit.autopsy.casemodule.Case.getMetadata().

Referenced by org.sleuthkit.autopsy.casemodule.Case.doCloseCaseAction(), and org.sleuthkit.autopsy.casemodule.Case.doOpenCaseAction().

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 729 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 739 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 749 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 679 of file Case.java.

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

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

private

Saves teh case metadata to a file.SHould not be called until the case directory has been created.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2592 of file Case.java.

References org.sleuthkit.autopsy.progress.ProgressIndicator.progress().

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

static void org.sleuthkit.autopsy.casemodule.Case.setDeletedItemFlag	(	CaseNodeData	caseNodeData,
		CaseNodeData.DeletedFlags	flag
	)		throws InterruptedException

staticprivate

Sets a deleted item flag in the coordination service node data for a multi-user case.

Parameters

caseNodeData	The coordination service node data for the case.
flag	The flag to set.

Exceptions

InterruptedException If interrupted while blocked waiting for coordination service data to be written to the coordination service node database.

Definition at line 3551 of file Case.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDirectory(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDisplayName(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getName(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setDeletedFlag(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.writeCaseNodeData().

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDirectory(), and org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseTextIndex().

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

private

Switches from writing log messages to the application logs to the logs subdirectory of the case directory.

Parameters

progressIndicator A progress indicator.

Definition at line 2572 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.getLogDirectoryPath(), org.sleuthkit.autopsy.progress.ProgressIndicator.progress(), and org.sleuthkit.autopsy.coreutils.Logger.setLogDirectory().

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

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

private

Updates the node data for the case directory lock coordination service node.

Parameters

progressIndicator A progress indicator.

Exceptions

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

Definition at line 2642 of file Case.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.getCaseType(), org.sleuthkit.autopsy.casemodule.Case.CaseType.MULTI_USER_CASE, org.sleuthkit.autopsy.progress.ProgressIndicator.progress(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setLastAccessDate(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.writeCaseNodeData().

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

void org.sleuthkit.autopsy.casemodule.Case.updateDataParameters ( ) throws TskCoreException

private

Initialize the hasData and hasDataSource parameters by checking the database.

hasDataSource will be true if any data Source exists the db.

hasData will be true if hasDataSource is true or if there are entries in the tsk_object or tsk_host tables.

Exceptions

TskCoreException

Definition at line 3572 of file Case.java.

References org.sleuthkit.autopsy.casemodule.Case.dbHasData(), and org.sleuthkit.autopsy.casemodule.Case.dbHasDataSource().

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

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

staticprivate

Definition at line 1387 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 1281 of file Case.java.

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

Member Data Documentation

final String org.sleuthkit.autopsy.casemodule.Case.APP_NAME = UserPreferences.getAppName()

staticprivate

Definition at line 167 of file Case.java.

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

Future<?> org.sleuthkit.autopsy.casemodule.Case.backgroundOpenFileSystemsFuture = null

staticprivate

Definition at line 183 of file Case.java.

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

staticprivate

Definition at line 171 of file Case.java.

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

staticprivate

Definition at line 177 of file Case.java.

final int org.sleuthkit.autopsy.casemodule.Case.CASE_LOCK_TIMEOUT_MINS = 1

staticprivate

Definition at line 165 of file Case.java.

final int org.sleuthkit.autopsy.casemodule.Case.CASE_RESOURCES_LOCK_TIMEOUT_HOURS = 1

staticprivate

Definition at line 166 of file Case.java.

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

staticprivate

Definition at line 178 of file Case.java.

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

private

Definition at line 189 of file Case.java.

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

staticprivate

Definition at line 182 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 191 of file Case.java.

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

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

private

Definition at line 190 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.acquireCaseLock(), and org.sleuthkit.autopsy.casemodule.Case.releaseCaseLock().

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

private

Definition at line 194 of file Case.java.

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

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

private

Definition at line 193 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.CONFIG_FOLDER = "Config"

staticprivate

Definition at line 175 of file Case.java.

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

staticprivate

Definition at line 187 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 String org.sleuthkit.autopsy.casemodule.Case.EVENT_CHANNEL_NAME = "%s-Case-Events"

staticprivate

Definition at line 170 of file Case.java.

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

staticprivate

Definition at line 181 of file Case.java.

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

staticprivate

Definition at line 172 of file Case.java.

volatile boolean org.sleuthkit.autopsy.casemodule.Case.hasData = false

private

Definition at line 197 of file Case.java.

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.caseHasData(), and org.sleuthkit.autopsy.casemodule.Case.updateGUIForCaseOpened().

volatile boolean org.sleuthkit.autopsy.casemodule.Case.hasDataSource = false

private

Definition at line 196 of file Case.java.

Referenced by org.sleuthkit.autopsy.ingest.RunIngestAction.isEnabled(), and org.sleuthkit.autopsy.timeline.OpenTimelineAction.showTimeline().

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

staticprivate

Definition at line 173 of file Case.java.

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

staticprivate

Definition at line 180 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 186 of file Case.java.

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

private

Definition at line 188 of file Case.java.

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

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

staticprivate

Definition at line 176 of file Case.java.

final String org.sleuthkit.autopsy.casemodule.Case.NO_NODE_ERROR_MSG_FRAGMENT = "KeeperErrorCode = NoNode"

staticprivate

Definition at line 179 of file Case.java.

final ExecutorService org.sleuthkit.autopsy.casemodule.Case.openFileSystemsExecutor = Executors.newSingleThreadExecutor(new ThreadFactoryBuilder().setNameFormat("case-open-file-systems-%d").build())

staticprivate

Definition at line 185 of file Case.java.

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

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

staticprivate

Definition at line 174 of file Case.java.

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

staticprivate

Definition at line 169 of file Case.java.

Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseDatabase(), and org.sleuthkit.autopsy.casemodule.Case.createPortableCase().

final SleuthkitEventListener org.sleuthkit.autopsy.casemodule.Case.sleuthkitEventListener

private

Definition at line 192 of file Case.java.

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

staticprivate

Definition at line 168 of file Case.java.

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

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