org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext Class Reference

Public Member Functions
	CaseContext (Case theCase, ProgressIndicator progressIndicator)
	CaseContext (Case theCase, ProgressIndicator progressIndicator, boolean isNewCase)
boolean	cancelRequested ()
Case	getCase ()
ProgressIndicator	getProgressIndicator ()
boolean	isNewCase ()
void	requestCancel ()

Private Attributes
volatile boolean	cancelRequested
final boolean	isNewCase
final ProgressIndicator	progressIndicator
final Case	theCase

Detailed Description

The context for the creation/opening/upgrading of case-level resources by a service.

Definition at line 88 of file AutopsyService.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.CaseContext	(	Case	theCase,
		ProgressIndicator	progressIndicator
	)

Constructs the context for the creation/opening/upgrading of case-level resources by a service.

Parameters

theCase	The case.
progressIndicator	A progress indicator for the opening of the case-level resources

Definition at line 103 of file AutopsyService.java.

References org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.progressIndicator, and org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.theCase.

org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.CaseContext	(	Case	theCase,
		ProgressIndicator	progressIndicator,
		boolean	isNewCase
	)

Constructs the context for the creation/opening/upgrading of case-level resources by a service.

Parameters

theCase	The case.
progressIndicator	A progress indicator for the opening of the case-level resources.
isNewCase	True if theCase is a new case.

Definition at line 116 of file AutopsyService.java.

References org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.isNewCase(), org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.progressIndicator, and org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.theCase.

Member Function Documentation

boolean org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.cancelRequested

(

)

Indicates whether or not cancellation of the creation/opening/upgrading of case-level resources by a service has been requested.

Returns

True or false.

Definition at line 160 of file AutopsyService.java.

Case org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.getCase

(

)

Gets the case for the creation/opening/upgrading of case-level resources by a service.

Returns

The case.

Definition at line 129 of file AutopsyService.java.

References org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.theCase.

Referenced by org.sleuthkit.autopsy.keywordsearch.SolrSearchService.closeCaseResources(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.openCaseResources(), and org.sleuthkit.autopsy.keywordsearch.SolrSearchService.openCaseResources().

ProgressIndicator org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.getProgressIndicator

(

)

Gets the progress indicator for the creation/opening/upgrading of case-level resources by a service. IMPORTANT: The service should only call progress() on the progress indicator. Calling start() and finish() are the responsibility of the case providing the context.

Returns

The progress indicator.

Definition at line 141 of file AutopsyService.java.

References org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.progressIndicator.

Referenced by org.sleuthkit.autopsy.casemodule.Case.CancelButtonListener.cancel(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.closeCaseResources(), org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.openCaseResources(), and org.sleuthkit.autopsy.keywordsearch.SolrSearchService.openCaseResources().

boolean org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.isNewCase

(

)

Indicates whether or the case is a new case in the process of being created.

Returns

True if it is a new case.

Definition at line 170 of file AutopsyService.java.

Referenced by org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.CaseContext().

void org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.requestCancel

(

)

Requests cancellation of the creation/opening/upgrading of case-level resources by a service. The request is not guaranteed to be honored.

Definition at line 149 of file AutopsyService.java.

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

Member Data Documentation

volatile boolean org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.cancelRequested

private

Definition at line 92 of file AutopsyService.java.

Referenced by org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepositoryService.openCaseResources(), and org.sleuthkit.autopsy.keywordsearch.SolrSearchService.openCaseResources().

final boolean org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.isNewCase

private

Definition at line 93 of file AutopsyService.java.

final ProgressIndicator org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.progressIndicator

private

Definition at line 91 of file AutopsyService.java.

Referenced by org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.CaseContext(), and org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.getProgressIndicator().

final Case org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.theCase

private

Definition at line 90 of file AutopsyService.java.

Referenced by org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.CaseContext(), and org.sleuthkit.autopsy.appservices.AutopsyService.CaseContext.getCase().

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/appservices/AutopsyService.java