org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer Class Reference

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

Public Member Functions
	ContextViewer ()
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
void	addSourceEntry (BlackboardArtifact artifact) throws TskCoreException
void	appendAttributeString (StringBuilder sb, BlackboardAttribute.ATTRIBUTE_TYPE attribType, Map< BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute > attributesMap, String prependStr)
Map< BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute >	getAttributesMap (BlackboardArtifact artifact) throws TskCoreException
void	initComponents ()
void	jSourceGoToResultButtonActionPerformed (java.awt.event.ActionEvent evt)
String	msgArtifactToAbbreviatedString (BlackboardArtifact artifact) throws TskCoreException
void	populateSourceContextData (AbstractFile sourceFile) throws NoCurrentCaseException, TskCoreException
void	setSourceFields (BlackboardArtifact associatedArtifact) throws TskCoreException
void	setSourceName (String nameLabel)
void	setSourceText (String text)
void	showSourceText (boolean show)
String	webDownloadArtifactToString (BlackboardArtifact artifact) throws TskCoreException

Private Attributes
javax.swing.JButton	jSourceGoToResultButton
javax.swing.JLabel	jSourceLabel
javax.swing.JLabel	jSourceNameLabel
javax.swing.JLabel	jSourceTextLabel
BlackboardArtifact	sourceContextArtifact

Static Private Attributes
static final int	ARTIFACT_STR_MAX_LEN = 1024
static final int	ATTRIBUTE_STR_MAX_LEN = 200
static final Logger	logger = Logger.getLogger(ContextViewer.class.getName())
static final long	serialVersionUID = 1L
static final List< BlackboardArtifact.ARTIFACT_TYPE >	SOURCE_CONTEXT_ARTIFACTS = new ArrayList<>()

Detailed Description

Displays additional context for the selected file, such as its source, and usage, if known.

Definition at line 49 of file ContextViewer.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.ContextViewer

(

)

Creates new form ContextViewer

Definition at line 68 of file ContextViewer.java.

Member Function Documentation

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.addSourceEntry ( BlackboardArtifact  artifact ) throws TskCoreException

private

Adds a source context entry for the selected file based on the given context providing artifact.

Parameters

artifact

Artifact that may provide context.

Exceptions

NoCurrentCaseException
TskCoreException

Definition at line 265 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.appendAttributeString ( StringBuilder  sb, BlackboardAttribute.ATTRIBUTE_TYPE  attribType, Map< BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute >  attributesMap, String  prependStr  )

private

Looks up specified attribute in the given map and, if found, appends its value to the given string builder.

Parameters

sb	String builder to append to.
attribType	Attribute type to look for.
attributesMap	Attributes map.
prependStr	Optional string that is prepended before the attribute value.

Definition at line 402 of file ContextViewer.java.

DataContentViewer org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 180 of file ContextViewer.java.

Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.getAttributesMap ( BlackboardArtifact  artifact ) throws TskCoreException

private

Gets all attributes for the given artifact, and returns a map of attributes keyed by attribute type.

Parameters

artifact

Artifact for which to get the attributes.

Returns

Map of attribute type and value.

Exceptions

TskCoreException

Definition at line 427 of file ContextViewer.java.

Component org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 185 of file ContextViewer.java.

String org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 170 of file ContextViewer.java.

String org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 175 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 80 of file ContextViewer.java.

int org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 220 of file ContextViewer.java.

boolean org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 197 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.jSourceGoToResultButtonActionPerformed ( java.awt.event.ActionEvent  evt )

private

Definition at line 138 of file ContextViewer.java.

References org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.findInstance(), and org.sleuthkit.autopsy.directorytree.DirectoryTreeTopComponent.viewArtifact().

String org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.msgArtifactToAbbreviatedString ( BlackboardArtifact  artifact ) throws TskCoreException

private

Returns a abbreviated display string for a message artifact.

Parameters

artifact

artifact to get download source URL from.

Returns

Display string for message artifact.

Exceptions

TskCoreException

Definition at line 373 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.populateSourceContextData ( AbstractFile  sourceFile ) throws NoCurrentCaseException, TskCoreException

private

Looks for context providing artifacts for the given file and populates the source context.

Parameters

sourceFile

File for which to show the context.

Exceptions

NoCurrentCaseException
TskCoreException

Definition at line 234 of file ContextViewer.java.

References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), and org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase().

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.resetComponent

(

)

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 190 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.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 150 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.setSourceFields ( BlackboardArtifact  associatedArtifact ) throws TskCoreException

private

Sets the source label and text fields based on the given associated artifact.

Parameters

associatedArtifact

- associated artifact

Exceptions

TskCoreException

Definition at line 292 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.setSourceName ( String  nameLabel )

private

Sets the source label string.

Parameters

nameLabel

String value for source label.

Definition at line 312 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.setSourceText ( String  text )

private

Sets the source text string.

Parameters

text	String value for source text.

Definition at line 321 of file ContextViewer.java.

void org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.showSourceText ( boolean  show )

private

Definition at line 326 of file ContextViewer.java.

String org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.webDownloadArtifactToString ( BlackboardArtifact  artifact ) throws TskCoreException

private

Returns a display string with download source URL from the given artifact.

Parameters

artifact

artifact to get download source URL from.

Returns

Display string with download URL and date/time.

Exceptions

TskCoreException

Definition at line 346 of file ContextViewer.java.

Member Data Documentation

final int org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.ARTIFACT_STR_MAX_LEN = 1024

staticprivate

Definition at line 53 of file ContextViewer.java.

final int org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.ATTRIBUTE_STR_MAX_LEN = 200

staticprivate

Definition at line 54 of file ContextViewer.java.

javax.swing.JButton org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.jSourceGoToResultButton

private

Definition at line 441 of file ContextViewer.java.

javax.swing.JLabel org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.jSourceLabel

private

Definition at line 442 of file ContextViewer.java.

javax.swing.JLabel org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.jSourceNameLabel

private

Definition at line 443 of file ContextViewer.java.

javax.swing.JLabel org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.jSourceTextLabel

private

Definition at line 444 of file ContextViewer.java.

final Logger org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.logger = Logger.getLogger(ContextViewer.class.getName())

staticprivate

Definition at line 52 of file ContextViewer.java.

final long org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.serialVersionUID = 1L

staticprivate

Definition at line 51 of file ContextViewer.java.

final List<BlackboardArtifact.ARTIFACT_TYPE> org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.SOURCE_CONTEXT_ARTIFACTS = new ArrayList<>()

staticprivate

Definition at line 57 of file ContextViewer.java.

BlackboardArtifact org.sleuthkit.autopsy.contentviewers.contextviewer.ContextViewer.sourceContextArtifact

private

Definition at line 63 of file ContextViewer.java.

---

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

• /home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/contentviewers/contextviewer/ContextViewer.java