Classes
class	CaseNodeDataException

enum	DeletedFlags

Public Member Functions
Date	getCreateDate ()

Path	getDirectory ()

String	getDisplayName ()

boolean	getErrorsOccurred ()

Date	getLastAccessDate ()

String	getName ()

boolean	isDeletedFlagSet (DeletedFlags flag)

void	setDeletedFlag (DeletedFlags flag)

void	setDisplayName (String displayName)

void	setErrorsOccurred (boolean errorsOccurred)

void	setLastAccessDate (Date lastAccessDate)

Static Public Member Functions
static CaseNodeData	createCaseNodeData (final CaseMetadata metadata) throws CaseNodeDataException, InterruptedException

static CaseNodeData	readCaseNodeData (String nodePath) throws CaseNodeDataException, InterruptedException

static void	writeCaseNodeData (CaseNodeData nodeData) throws CaseNodeDataException, InterruptedException

Private Member Functions
	CaseNodeData (CaseMetadata metadata) throws ParseException

	CaseNodeData (byte[] nodeData) throws IOException

int	getVersion ()

void	setMinorVersion (int minorVersion)

byte[]	toArray () throws IOException

Static Private Member Functions
static CaseMetadata	getCaseMetadata (String nodePath) throws CaseNodeDataException, CaseMetadataException

static CaseNodeData	upgradeCaseNodeData (String nodePath, CaseNodeData oldNodeData) throws CaseNodeDataException, CaseMetadataException, ParseException, IOException, CoordinationServiceException, InterruptedException

Private Attributes
Date	createDate

short	deletedItemFlags

Path	directory

String	displayName

boolean	errorsOccurred

Date	lastAccessDate

int	minorVersion

String	name

int	version

Static Private Attributes
static final Logger	logger = Logger.getLogger(CaseNodeData.class.getName())

static final int	MAJOR_VERSION = 2

static final int	MINOR_VERSION = 0

Detailed Description

Case data stored in a case directory coordination service node.

Definition at line 41 of file CaseNodeData.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeData ( CaseMetadata metadata ) throws ParseException

private

Uses case metadata to construct the case data to store in a case directory coordination service node.

Parameters

metadata The case meta data.

Exceptions

ParseException If there is an error parsing dates from string representations of dates in the meta data.

Definition at line 247 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.CaseMetadata.getDateFormat(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.MAJOR_VERSION, and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.MINOR_VERSION.

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.createCaseNodeData(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.upgradeCaseNodeData().

org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeData ( byte[] nodeData ) throws IOException

private

Uses the raw bytes from a case directory coordination service node to construct a case node data object.

Parameters

nodeData The raw bytes received from the coordination service.

Exceptions

IOException If there is an error reading the node data.

Definition at line 267 of file CaseNodeData.java.

Member Function Documentation

static CaseNodeData org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.createCaseNodeData ( final CaseMetadata metadata ) throws CaseNodeDataException, InterruptedException

static

Creates case node data from the metadata for a case and writes it to the appropriate case directory coordination service node, which must already exist.

Parameters

metadata The case metadata.

Returns: The case node data that was written to the coordination service node.

Exceptions

CaseNodeDataException	If there is an error creating or writing the case node data.
InterruptedException	If the current thread is interrupted while waiting for the coordination service.

Definition at line 84 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeData(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.CategoryNode.CASES, org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDirectory(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.getInstance(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.setNodeData(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.toArray().

Referenced by org.sleuthkit.autopsy.casemodule.Case.createCaseNodeData(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData().

static CaseMetadata org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getCaseMetadata ( String nodePath ) throws CaseNodeDataException, CaseMetadataException

staticprivate

Gets the metadata for a case.

Parameters

nodePath The case directory coordination service node path for the case.

Returns: The case metadata.

Exceptions

CaseNodeDataException	If the case metadata file or the case directory does not exist.
CaseMetadataException	If the case metadata cannot be read.

Definition at line 225 of file CaseNodeData.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.upgradeCaseNodeData().

Date org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getCreateDate ( )

Gets the date the case was created.

Returns: The create date.

Definition at line 345 of file CaseNodeData.java.

Path org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDirectory ( )

Gets the path of the case directory.

Returns: The case directory path.

Definition at line 336 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.directory.

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.createCaseNodeData(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseTextIndex(), and org.sleuthkit.autopsy.casemodule.Case.setDeletedItemFlag().

String org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getDisplayName ( )

Gets the display name of the case.

Returns: The case display name.

Definition at line 381 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.displayName.

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

boolean org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getErrorsOccurred ( )

Gets whether or not any errors occurred during the processing of any auto ingest job for the case.

Returns: True or false.

Definition at line 317 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.errorsOccurred.

Date org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getLastAccessDate ( )

Gets the date the case was last accessed.

Returns: The last access date.

Definition at line 354 of file CaseNodeData.java.

String org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getName ( )

Gets the unique and immutable name of the case.

Returns: The case name.

Definition at line 372 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.name.

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

int org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getVersion ( )

private

Gets the version number of this node data.

Returns: The version number.

Definition at line 298 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.version.

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData().

boolean org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.isDeletedFlagSet ( DeletedFlags flag )

Checks whether a given deleted item flag is set for the case.

Parameters

flag	The flag to check.

Returns: True or false.

Definition at line 401 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.DeletedFlags.getValue().

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

static CaseNodeData org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData ( String nodePath ) throws CaseNodeDataException, InterruptedException

static

Reads case data from a case directory coordination service node. If the data is missing, corrupted, or from an older version of the software, an attempt is made to remedy the situation using the case metadata.

Parameters

nodePath The case directory coordination service node path.

Returns: The case node data.

Exceptions

CaseNodeDataException	If there is an error reading or writing the case node data.
InterruptedException	If the current thread is interrupted while waiting for the coordination service.

Definition at line 109 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeData(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.CategoryNode.CASES, org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.createCaseNodeData(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getCaseMetadata(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.getInstance(), org.sleuthkit.autopsy.coordinationservice.CoordinationService.getNodeData(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getVersion(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.MAJOR_VERSION, and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.upgradeCaseNodeData().

Referenced by org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeDataCollector.getNodeData(), and org.sleuthkit.autopsy.casemodule.Case.updateCaseNodeData().

void org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setDeletedFlag ( DeletedFlags flag )

Sets a given deleted item flag.

Parameters

flag	The flag to set.

Definition at line 410 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.DeletedFlags.getValue().

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

void org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setDisplayName ( String displayName )

Sets the display name of the case.

Parameters

displayName The case display name.

Definition at line 390 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.displayName.

void org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setErrorsOccurred ( boolean errorsOccurred )

Sets whether or not any errors occurred during the processing of any auto ingest job for the case.

Parameters

errorsOccurred True or false.

Definition at line 327 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.errorsOccurred.

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.upgradeCaseNodeData().

void org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setLastAccessDate ( Date lastAccessDate )

Sets the date the case was last accessed.

Parameters

lastAccessDate The last access date.

Definition at line 363 of file CaseNodeData.java.

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

void org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setMinorVersion ( int minorVersion )

private

Sets the minor version number of this node data.

Parameters

minorVersion The version number.

Definition at line 307 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.minorVersion.

byte [] org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.toArray ( ) throws IOException

private

Gets the node data as a byte array that can be sent to the coordination service.

Returns: The node data as a byte array.

Exceptions

IOException If there is an error writing the node data to the array.

Definition at line 423 of file CaseNodeData.java.

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.createCaseNodeData().

static CaseNodeData org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.upgradeCaseNodeData	(	String	nodePath,
		CaseNodeData	oldNodeData
	)		throws CaseNodeDataException, CaseMetadataException, ParseException, IOException, CoordinationServiceException, InterruptedException

staticprivate

Upgrades older versions of node data to the current version and writes the data back to the case directory coordination service node.

Parameters

nodePath	The case directory coordination service node path.
oldNodeData	The outdated node data.

Returns: The updated node data.

Exceptions

CaseNodeDataException	If the case meta data file or case directory do not exist.
CaseMetadataException	If the case metadata cannot be read.

Definition at line 180 of file CaseNodeData.java.

References org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.CaseNodeData(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.getCaseMetadata(), org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.setErrorsOccurred(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.writeCaseNodeData().

Referenced by org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.readCaseNodeData().

static void org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.writeCaseNodeData ( CaseNodeData nodeData ) throws CaseNodeDataException, InterruptedException

static

Writes case data to a case directory coordination service node. Obtain the case data to be updated and written by calling createCaseNodeData() or readCaseNodeData().

Parameters

nodeData The case node data.

Exceptions

CaseNodeDataException	If there is an error writing the case node data.
InterruptedException	If the current thread is interrupted while waiting for the coordination service.

Definition at line 158 of file CaseNodeData.java.

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

Referenced by org.sleuthkit.autopsy.casemodule.Case.setDeletedItemFlag(), org.sleuthkit.autopsy.casemodule.Case.updateCaseNodeData(), and org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData.upgradeCaseNodeData().