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

Classes
class	MetaDataWorker

Public Member Functions
	Metadata ()

DataContentViewer	createInstance ()

Component	getComponent ()

String	getTitle ()

String	getTitle (Node node)

String	getToolTip ()

int	isPreferred (Node node)

boolean	isSupported (Node node)

void	resetComponent ()

void	setNode (Node node)

Private Member Functions
void	addAcquisitionDetails (StringBuilder sb, DataSource dataSource)

void	addDownloadSourceRow (StringBuilder sb, BlackboardArtifact associatedArtifact) throws TskCoreException

void	addHeader (StringBuilder sb, String header, boolean spaced)

void	addMonospacedRow (StringBuilder sb, String key)

void	addRow (StringBuilder sb, String key, String value)

void	addRowWithMultipleValues (StringBuilder sb, String key, String[] values)

void	customizeComponents ()

void	endTable (StringBuilder sb)

void	initComponents ()

void	setText (String str)

void	startTable (StringBuilder sb)

Private Attributes
javax.swing.JPopupMenu	jPopupMenu1

javax.swing.JScrollPane	jScrollPane2

javax.swing.JTextPane	jTextPane1

MetaDataWorker	worker

Static Private Attributes
static final Logger	LOGGER = Logger.getLogger(Metadata.class.getName())

Detailed Description

Shows file metadata as a list to make it easy to copy and paste. Typically shows the same data that can also be found in the ResultViewer table, just a different order and allows the full path to be visible in the bottom area.

Definition at line 61 of file Metadata.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.contentviewers.Metadata.Metadata ( )

Creates new form Metadata

Definition at line 70 of file Metadata.java.

References org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.setupHtmlJTextPane().

Member Function Documentation

void org.sleuthkit.autopsy.contentviewers.Metadata.addAcquisitionDetails	(	StringBuilder	sb,
		DataSource	dataSource
	)

private

Add the acquisition details to the results (if applicable)

Parameters

sb	The output StringBuilder object
dataSource	The data source (may be null)

Definition at line 250 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.addDownloadSourceRow	(	StringBuilder	sb,
		BlackboardArtifact	associatedArtifact
	)		throws TskCoreException

private

Adds a row for download source from the given associated artifact, if the associated artifacts specifies a source.

Parameters

sb	string builder.
associatedArtifact

Exceptions

TskCoreException if there is an error

Definition at line 233 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.addHeader	(	StringBuilder	sb,
		String	header,
		boolean	spaced
	)

private

Definition at line 132 of file Metadata.java.

References org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getHeaderClassName(), and org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getSpacedSectionClassName().

void org.sleuthkit.autopsy.contentviewers.Metadata.addMonospacedRow	(	StringBuilder	sb,
		String	key
	)

private

Definition at line 158 of file Metadata.java.

References org.sleuthkit.autopsy.coreutils.EscapeUtil.escapeHtml(), org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getKeyColumnClassName(), and org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getMonospacedClassName().

void org.sleuthkit.autopsy.contentviewers.Metadata.addRow	(	StringBuilder	sb,
		String	key,
		String	value
	)

private

Definition at line 148 of file Metadata.java.

References org.sleuthkit.autopsy.coreutils.EscapeUtil.escapeHtml(), org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getKeyColumnClassName(), and org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getTextClassName().

void org.sleuthkit.autopsy.contentviewers.Metadata.addRowWithMultipleValues	(	StringBuilder	sb,
		String	key,
		String[]	values
	)

private

Definition at line 166 of file Metadata.java.

References org.sleuthkit.autopsy.coreutils.EscapeUtil.escapeHtml().

DataContentViewer org.sleuthkit.autopsy.contentviewers.Metadata.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 291 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.customizeComponents ( )

private

Definition at line 114 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.endTable ( StringBuilder sb )

private

Definition at line 144 of file Metadata.java.

Component org.sleuthkit.autopsy.contentviewers.Metadata.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 296 of file Metadata.java.

String org.sleuthkit.autopsy.contentviewers.Metadata.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 269 of file Metadata.java.

String org.sleuthkit.autopsy.contentviewers.Metadata.getTitle ( Node node )

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

Parameters

node	The node to be viewed in the DataContentViewer.

Returns: the title of DataContentViewer.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 277 of file Metadata.java.

String org.sleuthkit.autopsy.contentviewers.Metadata.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 286 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.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 83 of file Metadata.java.

int org.sleuthkit.autopsy.contentviewers.Metadata.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 8 - Used for viewers that summarize a data artifact and display a relevant subset to help the examiner decide if they should look into it further. Not currently used by any modules, but an example would be a module that summarizes an email message.

Level 7 - Used for data artifact viewers. These have higher priority over file content viewers because a Node will likely have the ‘source’ file for a data artifact and we want to give the artifact priority. Currently used by the Data Artifacts viewer.

Level 6 - Used for type-specific file content viewers that summarize the file content and display a relevant subset. These viewers help the examiner determine if the file is worth looking into further. Examples of this would be Video Triage Module that displays a subset of a video or a document.

Level 5 - Used for type-specific file content viewers that are optimized for that type, such as displaying an image or a PDF file with images and proper layout. Currently used by the Application viewer.

Level 4 - Used for type-specific file content viewers that are not optimized. For example, displaying only the plain text from a PDF would be at this level, but displaying the same PDF with images and layout would be level 5. Currently used by the Text viewer that returns text from Solr.

Level 3 - Used for viewing Data Artifacts that refer to files and the user may want to view the files more than the artifact itself. This is currently used by the Data Artifact viewer when a Web Download artifact is selected.

Level 2 - Used for viewing Analysis Results. This is a lower priority than Data Artifacts and file content because Analysis Results are used to identify content of interest and therefore the content itself should be shown. Currently used by the Analysis Results viewer. * Level 1 - Used for metadata viewers that give more information and context about the primary file or artifact. Currently used by Metadata, Annotations, Context, Other Occurrences, and OS Account.

Level 0 - Used for general purpose file content viewers that are not file specific and will always be enabled. Currently used by Text/Strings and Hex.

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 313 of file Metadata.java.

References org.sleuthkit.autopsy.contentviewers.utils.ViewerPriority.viewerPriority.LevelOne.

boolean org.sleuthkit.autopsy.contentviewers.Metadata.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 306 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.resetComponent ( )

Resets the contents of the viewer / component.

Implements org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer.

Definition at line 301 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.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 192 of file Metadata.java.

void org.sleuthkit.autopsy.contentviewers.Metadata.setText ( String str )

private

Definition at line 127 of file Metadata.java.

References org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.setupHtmlJTextPane().

void org.sleuthkit.autopsy.contentviewers.Metadata.startTable ( StringBuilder sb )

private

Definition at line 139 of file Metadata.java.

References org.sleuthkit.autopsy.contentviewers.layout.ContentViewerHtmlStyles.getIndentedClassName().

Member Data Documentation

javax.swing.JPopupMenu org.sleuthkit.autopsy.contentviewers.Metadata.jPopupMenu1

private

Definition at line 109 of file Metadata.java.

javax.swing.JScrollPane org.sleuthkit.autopsy.contentviewers.Metadata.jScrollPane2

private

Definition at line 110 of file Metadata.java.

javax.swing.JTextPane org.sleuthkit.autopsy.contentviewers.Metadata.jTextPane1

private

Definition at line 111 of file Metadata.java.

final Logger org.sleuthkit.autopsy.contentviewers.Metadata.LOGGER = Logger.getLogger(Metadata.class.getName())

staticprivate

Definition at line 63 of file Metadata.java.

MetaDataWorker org.sleuthkit.autopsy.contentviewers.Metadata.worker

private

Definition at line 65 of file Metadata.java.

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

/home/carriersleuth/repos/autopsy/Core/src/org/sleuthkit/autopsy/contentviewers/Metadata.java

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation