org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact Class Reference

Inherits JPanel, and org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Classes
class	SelectedArtifactChangedTask
class	SelectedNodeChangedTask
class	ViewUpdate

Public Member Functions
	DataContentViewerArtifact ()
DataContentViewer	createInstance ()
Component	getComponent ()
String	getTitle ()
String	getToolTip ()
int	isPreferred (Node node)
boolean	isSupported (Node node)
void	resetComponent ()
void	setNode (Node selectedNode)

Private Member Functions
List< BlackboardArtifact >	getArtifactContents ()
ArtifactContentViewer	getSupportingViewer (BlackboardArtifact artifact)
void	initComponents ()
void	nextPageButtonActionPerformed (java.awt.event.ActionEvent evt)
void	prevPageButtonActionPerformed (java.awt.event.ActionEvent evt)
void	resetComponents ()
void	setArtifactContents (List< BlackboardArtifact > artifactList)
synchronized void	startNewTask (SwingWorker< ViewUpdate, Void > task)
void	updateView (ViewUpdate viewUpdate)

Private Attributes
javax.swing.JPanel	artifactContentPanel
javax.swing.JLabel	artifactLabel
List< BlackboardArtifact >	artifactTableContents
Node	currentNode
int	currentPage = 1
javax.swing.JLabel	currentPageLabel
SwingWorker< ViewUpdate, Void >	currentTask
javax.swing.Box.Filler	filler1
javax.swing.JPanel	jPanel1
javax.swing.JScrollPane	jScrollPane1
final Collection< ArtifactContentViewer >	knowArtifactViewers = new HashSet<>(Lookup.getDefault().lookupAll(ArtifactContentViewer.class))
final Object	lock = new Object()
javax.swing.JButton	nextPageButton
javax.swing.JLabel	ofLabel
javax.swing.JLabel	pageLabel
javax.swing.JLabel	pageLabel2
javax.swing.JButton	prevPageButton
javax.swing.JLabel	totalPageLabel

Static Private Attributes
static final String	ERROR_TEXT = NbBundle.getMessage(DataContentViewerArtifact.class, "DataContentViewerArtifact.errorText")
static final Logger	logger = Logger.getLogger(DataContentViewerArtifact.class.getName())
static final long	serialVersionUID = 1L
static final String	WAIT_TEXT = NbBundle.getMessage(DataContentViewerArtifact.class, "DataContentViewerArtifact.waitText")

Detailed Description

Instances of this class display the BlackboardArtifacts associated with the Content represented by a Node.

It goes through a list of known ArtifactContentViewer to find a viewer that supports a given artifact and then hands it the artifact to display.

Definition at line 55 of file DataContentViewerArtifact.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.DataContentViewerArtifact

(

)

Definition at line 75 of file DataContentViewerArtifact.java.

Member Function Documentation

DataContentViewer org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.createInstance

(

)

Create and return a new instance of your viewer. The reason that this is needed is because the specific viewer modules will be found via NetBeans Lookup and the type will only be DataContentViewer. This method is used to get an instance of your specific type.

Returns

A new instance of the viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 316 of file DataContentViewerArtifact.java.

List<BlackboardArtifact> org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.getArtifactContents ( )

private

Retrieve the cache of artifact represented as ResultsTableArtifacts.

Returns

A list of artifacts.

Definition at line 476 of file DataContentViewerArtifact.java.

Component org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.getComponent

(

)

Return the Swing Component to display. Implementations of this method that extend JPanel and do a 'return this;'. Otherwise return an internal instance of the JPanel.

Returns

the component which is displayed for this viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 321 of file DataContentViewerArtifact.java.

ArtifactContentViewer org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.getSupportingViewer ( BlackboardArtifact  artifact )

private

Definition at line 367 of file DataContentViewerArtifact.java.

String org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.getTitle

(

)

Returns the title of this viewer to display in the tab.

Returns

the title of DataContentViewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 306 of file DataContentViewerArtifact.java.

String org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.getToolTip

(

)

Returns a short description of this viewer to use as a tool tip for its tab.

Returns

the tooltip for this TextViewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 311 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.initComponents ( )

private

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

Definition at line 89 of file DataContentViewerArtifact.java.

int org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.isPreferred

(

Node

node

)

Checks whether the given viewer is preferred for the Node. This is a bit subjective, but the idea is that Autopsy wants to display the most relevant tab. The more generic the viewer, the lower the return value should be. This will only be called on viewers that support the given node (i.e., isSupported() has already returned true).

The following are some examples of the current levels in use. If the selected node is an artifact, the level may be determined by both the artifact and its associated file.

Level 7 - Based on the artifact, if any, in the selected node and specific to an artifact type or types. Current content viewers that can return level 7 are the Messages tab (only supported for email and SMS) and the Text tab when the selected node is a Keyword Search hit.

Level 6 - Based on the artifact, if any, in the selected node but not restricted to particular types. The current content viewer that can return level 6 is the Results tab. It returns this level for most artifact types, unless the associated file is assumed to be of greater interest (for example, a Hash Set Hit will not be level 6 because the file itself is of greater interest).

Level 5 - Based on the file in the selected node and very specific to the file type. The current content viewer that will return level 5 is the Application tab, which supports media files (such as images) and certain types of databases.

Level 4 - Based on the file in the selected node but fairly general. Currently this is the level returned by the Text tab if Keyword Search has been run (unless the node is a Keyword Search hit or a Credit Card account). This is the default tab for most files.

Level 3 - Based on the artifact, if any, in the selected node where the artifact is thought to be of less interest than the associated file. This level is returned by the Results tab for artifacts like Hash Set Hits.

Level 1 - Very general and should always be available. The Hex, Text, and Metadata tabs are all this level

Level 0 - For cases where the content viewer should never be displayed by default.

Parameters

node	Node to check for preference

Returns

an int (0-10) higher return means the viewer has higher priority

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 349 of file DataContentViewerArtifact.java.

boolean org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.isSupported

(

Node

node

)

Checks whether the given node is supported by the viewer. This will be used to enable or disable the tab for the viewer.

Parameters

node	Node to check for support

Returns

True if the node can be displayed / processed, else false

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 331 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.nextPageButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 238 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.prevPageButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 245 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.resetComponent

(

)

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 326 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.resetComponents ( )

private

Resets the components to an empty view state.

Definition at line 270 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.setArtifactContents ( List< BlackboardArtifact >  artifactList )

private

Populate the cache of artifacts represented as ResultsTableArtifacts.

Parameters

artifactList

A list of ResultsTableArtifact representations of artifacts.

Definition at line 465 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.setNode

(

Node

selectedNode

)

Autopsy will call this when this panel is focused with the file that should be analyzed. When called with null, must clear all references to previous nodes.

Parameters

selectedNode

the node which is used to determine what is displayed in this viewer

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 284 of file DataContentViewerArtifact.java.

synchronized void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.startNewTask ( SwingWorker< ViewUpdate, Void >  task )

private

Start a new task on its own background thread, canceling the previous task.

Parameters

task	A new SwingWorker object to execute as a background thread.

Definition at line 445 of file DataContentViewerArtifact.java.

void org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.updateView ( ViewUpdate  viewUpdate )

private

Called from queued SwingWorker done() methods on the EDT thread, so doesn't need to be synchronized.

Parameters

viewUpdate

A simple container for display update information from a background thread.

Definition at line 409 of file DataContentViewerArtifact.java.

References org.sleuthkit.autopsy.contentviewers.artifactviewers.ArtifactContentViewer.getComponent(), and org.sleuthkit.autopsy.contentviewers.artifactviewers.ArtifactContentViewer.setArtifact().

Member Data Documentation

javax.swing.JPanel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.artifactContentPanel

private

Definition at line 253 of file DataContentViewerArtifact.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.artifactLabel

private

Definition at line 254 of file DataContentViewerArtifact.java.

List<BlackboardArtifact> org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.artifactTableContents

private

Definition at line 70 of file DataContentViewerArtifact.java.

Node org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.currentNode

private

Definition at line 67 of file DataContentViewerArtifact.java.

int org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.currentPage = 1

private

Definition at line 68 of file DataContentViewerArtifact.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.currentPageLabel

private

Definition at line 255 of file DataContentViewerArtifact.java.

SwingWorker<ViewUpdate, Void> org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.currentTask

private

Definition at line 71 of file DataContentViewerArtifact.java.

final String org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.ERROR_TEXT = NbBundle.getMessage(DataContentViewerArtifact.class, "DataContentViewerArtifact.errorText")

staticprivate

Definition at line 65 of file DataContentViewerArtifact.java.

javax.swing.Box.Filler org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.filler1

private

Definition at line 256 of file DataContentViewerArtifact.java.

javax.swing.JPanel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.jPanel1

private

Definition at line 257 of file DataContentViewerArtifact.java.

javax.swing.JScrollPane org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.jScrollPane1

private

Definition at line 258 of file DataContentViewerArtifact.java.

final Collection<ArtifactContentViewer> org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.knowArtifactViewers = new HashSet<>(Lookup.getDefault().lookupAll(ArtifactContentViewer.class))

private

Definition at line 73 of file DataContentViewerArtifact.java.

final Object org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.lock = new Object()

private

Definition at line 69 of file DataContentViewerArtifact.java.

final Logger org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.logger = Logger.getLogger(DataContentViewerArtifact.class.getName())

staticprivate

Definition at line 63 of file DataContentViewerArtifact.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.nextPageButton

private

Definition at line 259 of file DataContentViewerArtifact.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.ofLabel

private

Definition at line 260 of file DataContentViewerArtifact.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.pageLabel

private

Definition at line 261 of file DataContentViewerArtifact.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.pageLabel2

private

Definition at line 262 of file DataContentViewerArtifact.java.

javax.swing.JButton org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.prevPageButton

private

Definition at line 263 of file DataContentViewerArtifact.java.

final long org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.serialVersionUID = 1L

staticprivate

Definition at line 57 of file DataContentViewerArtifact.java.

javax.swing.JLabel org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.totalPageLabel

private

Definition at line 264 of file DataContentViewerArtifact.java.

final String org.sleuthkit.autopsy.corecomponents.DataContentViewerArtifact.WAIT_TEXT = NbBundle.getMessage(DataContentViewerArtifact.class, "DataContentViewerArtifact.waitText")

staticprivate

Definition at line 64 of file DataContentViewerArtifact.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/corecomponents/DataContentViewerArtifact.java