Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="confluenceTable"><tbody><tr><th class="nohighlight confluenceTh"><strong>Name</strong></th><th class="nohighlight confluenceTh">Java Ecosystem</th></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">Latest version</span></strong></td><td class="confluenceTd"><span style="color: rgb(0,0,0);"><strong>1.2</strong> ( 13 March 2013 )</span></td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">Requires Sonar version</span></strong></td><td class="confluenceTd"><span style="color: rgb(0,0,0);"><strong>3.4</strong> or higher ( check </span><a href="http://docs.codehaus.org/display/SONAR/Plugin+version+matrix">version compatibility</a> )</td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">Download</span></strong></td><td class="confluenceTd"><a class="confluence-link unresolved" data-filename="JavaEcosystem-1.2.zip" data-linked-resource-default-alias="JavaEcosystem-1.2.zip" href="#">JavaEcosystem-1.2.zip</a></td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">License</span></strong></td><td class="confluenceTd"><span style="color: rgb(0,0,0);">GNU LGPL 3</span></td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">Developers</span></strong></td><td class="confluenceTd"><a href="http://www.sonarsource.com">SonarSource</a></td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">Issue tracker</span></strong></td><td class="confluenceTd"><a href="http://jira.codehaus.org/browse/SONARJAVA">http://jira.codehaus.org/browse/SONARJAVA</a><br /><a href="http://jira.codehaus.org/browse/SONARPLUGINS/component/14640" /></td></tr><tr><td class="confluenceTd"><strong><span style="color: rgb(0,0,0);">Sources</span></strong></td><td class="confluenceTd"><a href="https://github.com/SonarSource/sonar-java">https://github.com/SonarSource/sonar-java</a></td></tr></tbody></table><table class="wysiwyg-macro" data-macro-name="tip" data-macro-parameters="title=Live example" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3RpcDp0aXRsZT1MaXZlIGV4YW1wbGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>If you want to see a live example of the capabilities of the Java Ecosystem, you can have a look at <a href="http://nemo.sonarsource.org/dashboard/index/48569">Sonar on Sonar</a>.</p></td></tr></table><h1>Description / Features</h1><p>The Java Ecosystem is a set of Sonar plugins used to monitor the quality of Java projects within Sonar.</p><p>It is compatible with the <a class="confluence-link" href="/display/SONAR/Using+Sonar+in+Eclipse" data-linked-resource-id="186712286" data-linked-resource-type="page" data-linked-resource-default-alias="Using Sonar in Eclipse" data-base-url="http://docs.codehaus.org">Sonar Eclipse plugin</a> to track violations while coding. I<span style="font-size: 10.0pt;line-height: 13.0pt;">t is also compatible with </span><span style="font-size: 10.0pt;line-height: 13.0pt;">the </span><a class="confluence-link" href="/display/SONAR/Issues+Report+Plugin" data-linked-resource-id="230398911" data-linked-resource-type="page" data-linked-resource-default-alias="Issues Report Plugin" data-base-url="http://docs.codehaus.org">Issues Report plugin</a><span style="font-size: 10.0pt;line-height: 13.0pt;"> to run pre-commit local analysis.</span></p><h1>Installation</h1><p><span style="color: rgb(51,51,51);font-size: 10.0pt;font-weight: normal;line-height: 13.0pt;">The Java Ecosystem is a set of plugins:</span></p><ul><li><strong>Java</strong> [sonar-java-plugin]: to parse Java code source, compute metrics, etc.</li><li><strong><strong>Squid</strong></strong> [sonar-squid-java-plugin]: to compute additional metrics, check code against rules provided by the Sonar engine</li><li><strong style="font-size: 10.0pt;line-height: 13.0pt;"><strong><strong><a class="confluence-link" href="/display/SONAR/Checkstyle+Plugin" data-linked-resource-id="230397166" data-linked-resource-type="page" data-linked-resource-default-alias="Checkstyle Plugin" data-base-url="http://docs.codehaus.org">Checkstyle</a></strong></strong></strong><span style="font-size: 10.0pt;line-height: 13.0pt;"> [sonar-checkstyle-plugin]: to check code against rules provided by </span><a href="http://checkstyle.sourceforge.net/" style="font-size: 10.0pt;line-height: 13.0pt;">Checkstyle</a></li><li><strong style="font-size: 10.0pt;line-height: 13.0pt;"><strong><strong><a class="confluence-link" href="/display/SONAR/FindBugs+Plugin" data-linked-resource-id="230397153" data-linked-resource-type="page" data-linked-resource-default-alias="FindBugs Plugin" data-base-url="http://docs.codehaus.org">FindBugs</a></strong></strong></strong><span style="font-size: 10.0pt;line-height: 13.0pt;"> [sonar-findbugs-plugin]: to check code against rules provided by </span><a href="http://findbugs.sourceforge.net/" style="font-size: 10.0pt;line-height: 13.0pt;">FindBugs</a></li><li><strong style="font-size: 10.0pt;line-height: 13.0pt;"><strong><strong><a class="confluence-link" href="/display/SONAR/PMD+Plugin" data-linked-resource-id="230397163" data-linked-resource-type="page" data-linked-resource-default-alias="PMD Plugin" data-base-url="http://docs.codehaus.org">PMD</a></strong></strong></strong><span style="font-size: 10.0pt;line-height: 13.0pt;"> [sonar-pmd-plugin]: to check code against rules provided by </span><a href="http://pmd.sourceforge.net/" style="font-size: 10.0pt;line-height: 13.0pt;">PMD</a></li><li><strong style="font-size: 10.0pt;line-height: 13.0pt;">Surefire </strong><span style="font-size: 10.0pt;line-height: 13.0pt;">[sonar-surefire-plugin]: to execute unit tests with </span><a href="http://maven.apache.org/surefire/" style="font-size: 10.0pt;line-height: 13.0pt;">Surefire</a></li><li><strong style="font-size: 10.0pt;line-height: 13.0pt;"><strong><strong><a class="confluence-link" href="/display/SONAR/Cobertura+Plugin" data-linked-resource-id="230397053" data-linked-resource-type="page" data-linked-resource-default-alias="Cobertura Plugin" data-base-url="http://docs.codehaus.org">Cobertura</a></strong></strong></strong><span style="font-size: 10.0pt;line-height: 13.0pt;"> [sonar-cobertura-plugin]: to get code coverage with </span><a href="http://cobertura.sourceforge.net/" style="font-size: 10.0pt;line-height: 13.0pt;">Cobertura</a></li><li><strong style="font-size: 10.0pt;line-height: 13.0pt;"><a class="confluence-link" href="/display/SONAR/JaCoCo+Plugin" data-linked-resource-id="230397046" data-linked-resource-type="page" data-linked-resource-default-alias="JaCoCo Plugin" data-base-url="http://docs.codehaus.org">JaCoCo</a> </strong><span style="font-size: 10.0pt;line-height: 13.0pt;">[sonar-jacoco-plugin]: to get code coverage with </span><a href="http://www.eclemma.org/jacoco/" style="font-size: 10.0pt;line-height: 13.0pt;">JaCoCo</a></li></ul><p>Note that by default the Java Ecosystem is provided with Sonar. <span style="font-size: 10.0pt;line-height: 13.0pt;">You can update it from the </span><a class="confluence-link" href="/display/SONAR/Update+Center" data-linked-resource-id="185598091" data-linked-resource-type="page" data-linked-resource-default-alias="Update Center" data-base-url="http://docs.codehaus.org">Update Center</a><span style="font-size: 10.0pt;line-height: 13.0pt;"> (since Sonar 3.5) or download the latest release from this page header.</span></p><p><span style="font-size: 10.0pt;line-height: 13.0pt;">Once the Java Ecosystem is installed, other plugins are available for download: <a class="confluence-link" href="/display/SONAR/Emma+Plugin" data-linked-resource-id="116359204" data-linked-resource-type="page" data-linked-resource-default-alias="Emma Plugin" data-base-url="http://docs.codehaus.org">Emma</a>, <a class="confluence-link" href="/display/SONAR/Clover+Plugin" data-linked-resource-id="194314488" data-linked-resource-type="page" data-linked-resource-default-alias="Clover Plugin" data-base-url="http://docs.codehaus.org">Clover</a>, etc.</span></p><h1>Usage</h1><h3>Run a Sonar Analysis</h3><p>To launch a Sonar analysis of your Java project, it is recommended to use the following <a class="confluence-link" href="/display/SONAR/Analyzing+Source+Code" data-linked-resource-id="113541695" data-linked-resource-type="page" data-linked-resource-default-alias="Analyzing Source Code" data-base-url="http://docs.codehaus.org">analyzers</a>:</p><ul><li><a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Maven">Maven</a> for Maven projects</li><li><a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Ant+Task">Ant</a> for Ant projects</li><li><a href="http://docs.codehaus.org/display/SONAR/Analyzing+with+Sonar+Runner" style="font-size: 10.0pt;line-height: 13.0pt;">Sonar Runner</a> otherwise</li></ul><p>Sample projects for each analyzer are available on GitHub that can be <a class="external-link" href="https://github.com/SonarSource/sonar-examples" rel="nofollow">browsed</a> or <a class="external-link" href="https://github.com/SonarSource/sonar-examples/zipball/master" rel="nofollow">downloaded</a>: /projects/languages/java</p><p>Notes:</p><ul><li>The source directory should be set to the directory containing the top parent package. <span style="font-size: 10.0pt;line-height: 13.0pt;">For example, if your directory structure is 'src/main/java/com/mycompany/...', the source directory must be set to 'src/main/java'.</span></li><li><span style="font-size: 10.0pt;line-height: 13.0pt;">The source directory tree has to match the package declaration. </span><span style="font-size: 10.0pt;line-height: 13.0pt;">For example, the following class:</span></li></ul><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=java|linenumbers=true|title=MyClass.java" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9TXlDbGFzcy5qYXZhfGxpbmVudW1iZXJzPXRydWV8bGFuZ3VhZ2U9amF2YX0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>package com.mycompany.mypackage;
...</pre></td></tr></table><p style="margin-left: 30.0px;"><span style="font-size: 10.0pt;line-height: 13.0pt;">must be located in the following directory: [mySourceDirectory]/com/mycompany/mypackage/MyClass.java. </span><span style="font-size: 10.0pt;line-height: 13.0pt;">Otherwise you would get such an error while running your analysis:</span></p><table class="wysiwyg-macro" data-macro-name="code" data-macro-parameters="language=none|title=Log" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6dGl0bGU9TG9nfGxhbmd1YWdlPW5vbmV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>Exception in thread "main" org.sonar.batch.bootstrapper.BootstrapException: org.sonar.squid.api.AnalysisException: Got an exception - org.sonar.squid.api.AnalysisException: The source directory does not correspond to the package declaration com.mycompany.mypackage, file : ..\src\MyClass.java
...</pre></td></tr></table><h3>Tests and Code Coverage</h3><p>The default code coverage engine for unit tests can be set in Settings &gt; Configuration &gt; General Settings &gt; Java &gt; <span style="color: rgb(68,68,68);">Code coverage plugin property.</span></p><p>By default the code coverage engine is <a class="confluence-link" href="/display/SONAR/JaCoCo+Plugin" data-linked-resource-id="230397046" data-linked-resource-type="page" data-linked-resource-default-alias="JaCoCo Plugin" data-base-url="http://docs.codehaus.org">JaCoCo</a> but <a class="confluence-link" href="/display/SONAR/Cobertura+Plugin" data-linked-resource-id="230397053" data-linked-resource-type="page" data-linked-resource-default-alias="Cobertura Plugin" data-base-url="http://docs.codehaus.org">Cobertura</a>, <a class="confluence-link" href="/display/SONAR/Emma+Plugin" data-linked-resource-id="116359204" data-linked-resource-type="page" data-linked-resource-default-alias="Emma Plugin" data-base-url="http://docs.codehaus.org">Emma</a> or <a class="confluence-link" href="/display/SONAR/Clover+Plugin" data-linked-resource-id="194314488" data-linked-resource-type="page" data-linked-resource-default-alias="Clover Plugin" data-base-url="http://docs.codehaus.org">Clover</a> can also be used.</p><p>To deal with unit tests and code coverage for Java project in Sonar, see <a class="confluence-link" href="/display/SONAR/Code+Coverage+by+Unit+Tests+for+Java+Project" data-linked-resource-id="230397062" data-linked-resource-type="page" data-linked-resource-default-alias="Code Coverage by Unit Tests for Java Project" data-base-url="http://docs.codehaus.org">Code Coverage by Unit Tests for Java Project tutorial</a>.</p><p>To deal with integration tests and code coverage for Java project in Sonar, see <a class="confluence-link" href="/display/SONAR/Code+Coverage+by+Integration+Tests+for+Java+Project" data-linked-resource-id="230397090" data-linked-resource-type="page" data-linked-resource-default-alias="Code Coverage by Integration Tests for Java Project" data-base-url="http://docs.codehaus.org">Code Coverage by Integration Tests for Java Project tutorial</a>.</p><h3>Advanced Settings</h3><p>Documentation on advanced parameters is available on the <a class="confluence-link" href="/display/SONAR/Analysis+Parameters" data-linked-resource-id="113541435" data-linked-resource-type="page" data-linked-resource-default-alias="Analysis Parameters" data-base-url="http://docs.codehaus.org">Analysis Parameters page</a>.</p><p>Advanced parameters specific to Java are:</p><table class="confluenceTable"><tbody><tr><td class="highlight confluenceTd" colspan="1">Key</td><td class="highlight confluenceTd" colspan="1">Description</td><td class="highlight confluenceTd" colspan="1">Default value</td></tr><tr><td class="confluenceTd"><p><strong>sonar.java.source</strong></p></td><td class="confluenceTd"><p>Compatibility of your source code regarding Java version.</p><p>This property is not used by the Sonar core but can be used by Java Sonar plugins like the PMD plugin. </p></td><td class="confluenceTd"><p>1.5</p></td></tr></tbody></table><h3>FAQ</h3><p>See <a class="confluence-link" href="/display/SONAR/Java+Ecosystem+FAQ" data-linked-resource-id="230397130" data-linked-resource-type="page" data-linked-resource-default-alias="Java Ecosystem FAQ" data-base-url="http://docs.codehaus.org">Java Ecosystem FAQ</a>.</p><h1>Metrics</h1><p>See <a class="confluence-link" href="/display/SONAR/Metric+definitions" data-linked-resource-id="230397406" data-linked-resource-type="page" data-linked-resource-default-alias="Metric definitions" data-base-url="http://docs.codehaus.org">Metrics documentation page</a>.</p><h1>Android</h1><p>A sample project with code coverage computed with Emma is available on GitHub that can be <a class="external-link" href="https://github.com/SonarSource/sonar-examples" rel="nofollow">browsed</a> or <a class="external-link" href="https://github.com/SonarSource/sonar-examples/zipball/master" rel="nofollow">downloaded</a>: /projects/android</p><h1>Extending Coding Rules using XPath</h1><p>New coding rules can be added using XPath. See the related <a class="confluence-link" href="/display/SONAR/Extending+Coding+Rules#ExtendingCodingRules-extendingRulesXPath" data-anchor="extendingRulesXPath" data-linked-resource-id="183205932" data-linked-resource-type="page" data-linked-resource-default-alias="Extending Coding Rules#extendingRulesXPath" data-base-url="http://docs.codehaus.org">documentation</a>.</p><p>To navigate the AST, download the <a href="http://repository.codehaus.org/org/codehaus/sonar-plugins/java/sslr-java-toolkit/1.2/sslr-java-toolkit-1.2.jar">SSLR Java Toolkit</a>.</p><h1>Change Log</h1><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxLjMgKHVucmVsZWFzZWQpfHJlbmRlck1vZGU9c3RhdGljfHdpZHRoPTkwMHxjb2x1bW5zPXR5cGU7a2V5O3N1bW1hcnk7cHJpb3JpdHk7c3RhdHVzfHVybD1odHRwOi8vamlyYS5jb2RlaGF1cy5vcmcvc3IvamlyYS5pc3N1ZXZpZXdzOnNlYXJjaHJlcXVlc3QteG1sL3RlbXAvU2VhcmNoUmVxdWVzdC54bWw_Zml4Zm9yPTE5MDU2JnBpZD0xMjgzMCZzb3J0ZXIvZmllbGQ9cHJpb3JpdHkmc29ydGVyL29yZGVyPURFU0MmdGVtcE1heD0xMDAwfQ&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority;status|renderMode=static|title=Version 1.3 (unreleased)|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=19056&amp;pid\=12830&amp;sorter/field\=priority&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxLjJ8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODk1NiZwaWQ9MTI4MzAmc29ydGVyL2ZpZWxkPXByaW9yaXR5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 1.2|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18956&amp;pid\=12830&amp;sorter/field\=priority&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p><p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2ppcmFpc3N1ZXM6YW5vbnltb3VzPXRydWV8dGl0bGU9VmVyc2lvbiAxLjF8cmVuZGVyTW9kZT1zdGF0aWN8d2lkdGg9OTAwfGNvbHVtbnM9dHlwZTtrZXk7c3VtbWFyeTtwcmlvcml0eXx1cmw9aHR0cDovL2ppcmEuY29kZWhhdXMub3JnL3NyL2ppcmEuaXNzdWV2aWV3czpzZWFyY2hyZXF1ZXN0LXhtbC90ZW1wL1NlYXJjaFJlcXVlc3QueG1sP2ZpeGZvcj0xODkzNyZwaWQ9MTI4MzAmc29ydGVyL2ZpZWxkPXByaW9yaXR5JnNvcnRlci9vcmRlcj1ERVNDJnRlbXBNYXg9MTAwMH0&amp;locale=en_GB&amp;version=2" data-macro-name="jiraissues" data-macro-parameters="anonymous=true|columns=type;key;summary;priority|renderMode=static|title=Version 1.1|url=http://jira.codehaus.org/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?fixfor\=18937&amp;pid\=12830&amp;sorter/field\=priority&amp;sorter/order\=DESC&amp;tempMax\=1000|width=900"></p><p> </p>