JBoss.orgCommunity Documentation
JBoss Tattletale can be downloaded in its binary form for easy installation.
The download location is: http://www.jboss.org/tattletale/downloads
Once downloaded extract the files by executing:
unzip jboss-tattletale-1.2.0.Beta1.zip
or
tar xzf jboss-tattletale-1.2.0.Beta1.tar.gz
depending on which archive type you downloaded.
JBoss Tattletale is now located in a folder under the directory you extracted the files into.
The JBoss Tattletale project is published in the JBoss Maven2 repository:
https://repository.jboss.org/nexus/content/groups/public/org/jboss/tattletale/
under the group id of: org.jboss.tattletale
The artifacts for the project are
Developer snapshots are published on the JBoss Snapshots Maven2 server:
https://repository.jboss.org/nexus/content/repositories/snapshots/
If you want to experiment with the latest developments you may checkout the latest code from GitHub (formerly in SVN). Be aware that the information provided in this manual might then not be accurate.
You can clone the repository onto your computer by the following command. This automatically creates a directory 'tattletale' within your current directory. Please note that this would be a read-only directory.
git clone git://github.com/jesperpedersen/tattletale.git
Should you want to edit the sources yourself, it is best to create your own fork of the repository and then clone that particular fork on your command line. Should you need help with Git and GitHub then read the help files (http://help.github.com/)
The project is compiled using Java Development Kit 1.5 or higher, Apache Ant 1.8 or higher and Apache Ivy 2.2 or higher. Using
ant <target>
where target is one of
dist
Builds the distribution.
release
Builds the release archives.
doc
Builds the documentation for the project.
clean
Cleans the project of temporary files.
See the full list of targets in the main build.xml file.
The configuration of JBoss Tattletale is done through its
jboss-tattletale.properties
file.
The current configuration parameters includes:
Table 3.1. JBoss Tattletale configuration
| Key | Value |
|---|---|
reports |
A comma separated list of which reports that should be generated.
The following reports are supported:
Default: All reports ( |
classloader |
Specifies which classloader structure that should be used when scanning the archives.
Can be one of the following:
|
profiles |
Specifies a comma separated list of profiles to resolve against.
The following profiles are supported:
|
excludes |
A comma separated list of directories or files that should be excluded from the scan. F.ex.
|
blacklisted |
A comma separated list of black listed classes or packages. F.ex.
|
scan |
A comma separated list of file extensions that should be scanned
Default: |
enableDot |
Should images be generated if the Graphviz DOT application is found
Default: |
graphvizDot |
The full path to the Graphviz DOT executable. This property is required if you want to generate
PNG files and the Graphviz bin directory is not on your path. F.ex.
|
The load order for the configuration file is
configuration parameter in the Apache Ant / Maven task
-Djboss-tattletale.properties system property
jboss-tattletale.properties file in current directory
jboss-tattletale.properties file in class loader
NOTE: The classloader structure feature is currently based on directory structures and may therefore fail to identify archives that should be included in the reports. If you want to be sure that all archives are included use the NoopClassLoaderStructure plugin.
JBoss Tattletale supports filtering of the warnings and errors that the reports generates.
This functionality allows the user to filter out any warnings or errors that should be ignored and thereby allow the application to successful terminate.
The format of the filter properties file is
An example:
myreport=myfilter
The load order for the filter file is
filter parameter in the Apache Ant / Maven task
-Djboss-tattletale-filter.properties system property
jboss-tattletale-filter.properties file in current directory
See the individual reports for filtering support.
Running JBoss Tattletale is very easy
java -Xmx512m -jar tattletale.jar [-exclude=<excludes>] <sourcedir> [<outputdir>]
where the "sourcedir" is the directory that contains your Java archives and the optional "outputdir" parameter is the directory where you would like your reports to be generated. The "-exclude" option let you exclude directories or file on the command line - see the configuration file for syntax.
Tattletale can also be run against specific compiled Archives. These can be singular or multiple files provided in the command line and separated using a # delimeter.
java -Xmx512m -jar tattletale.jar myApp.jar#yourApp.war#amazingApp.ear report
The main file will be generated under the report directory as index.html.
JBoss Tattletale will scan for Java (.jar), Web (.war) and Enterprise (.ear) Archive files.
JBoss Tattletale requires Java Runtime Environment 5 or higher.
Copyright © 2011 Red Hat Middleware