Run direct goals

Execute your report plugins or lauch "mvn site". Then call xradar's goals :

				
<build>
  <plugins>
  
  ...
  	
    <plugin>
  	  <groupId>net.sf.xradar</groupId>
  	  <artifactId>maven-xradar-plugin</artifactId>
  	  <version>1.2.2</version>
  	</plugin>
  </plugins>
 
</build>
			
			

Use maven-xradar-plugin as part of maven site lifecycle

				
<reporting>
  <plugins>
  
  ...
  	
    <plugin>
  	  <groupId>net.sf.xradar</groupId>
  	  <artifactId>maven-xradar-plugin</artifactId>
  	  <version>1.2.2</version>
  	</plugin>
  </plugins>
</reporting>
			
			

Automatic mode (default mode)

Just add the maven-xradar-plugin declaration in your pom, then execute mvn site :

				
<reporting>
  <plugins>
    <plugin>
  	  <groupId>net.sf.xradar</groupId>
  	  <artifactId>maven-xradar-plugin</artifactId>
  	  <version>1.2.2</version>
  	</plugin>
  </plugins>
</reporting>
			
			

See the result in the report section of your project's site.

Custom mode

Add your custom configurations and at last the maven-xradar-plugin declaration in your pom, then execute mvn site or mvn clean compile site :

For example :

				
<reporting>
  <plugins>	
  
  ...
  
    <plugin>
      <artifactId>maven-pmd-plugin</artifactId>
        <configuration>
			<linkXref>true</linkXref>
			<sourceEncoding>utf-8</sourceEncoding>
			<minimumTokens>100</minimumTokens>
			<targetJdk>1.5</targetJdk>
		</configuration>
	</plugin>
	
  ...	

	<plugin>
  	  <groupId>net.sf.xradar</groupId>
  	  <artifactId>maven-xradar-plugin</artifactId>
  	  <version>1.2.2</version>
  	  <configuration>
  	    <autoRadar>true</autoRadar> <!--false to execute only the plugins declared-->
  	  </configuration>
  	</plugin>
  </plugins>
</reporting>
			
			

Aggregator mode

Add the maven-xradar-plugin declaration in your pom and configure the path to the already report files generated, then execute mvn site :

For example :

				
<reporting>
  <plugins>	
	<plugin>
  	  <groupId>net.sf.xradar</groupId>
  	  <artifactId>maven-xradar-plugin</artifactId>
  	  <version>1.2.2</version>
  	  <configuration>
  	    <autoRadar>false</autoRadar> <!--need to be set at false-->
  	    <reportPmd>${project.build.directory}/resources/pmd.xml</reportPmd>
  	    <reportCheckstyle>${project.build.directory}/resources/checkstyle.xml</reportCheckstyle>
      </configuration>
  	</plugin>
  </plugins>
</reporting>
			
			

What do you need else ?

To analyse your project, XRadar, and therefore its maven plugin, needs a couple more files:

1. src/main/resources/xradar/radar-config.xml
2. src/main/resources/xradar/release{version}.properties , (where {version} is the version of your project declared in its pom.xml)

Note, that if you didn't create those files XRadar will use default ones.

you can see default files as examples here : xradar-config-default.xml and here : default-release.properties

To have XRadar static and dynamic analyse of your project run " mvn site ". To be sure that your are analysing the last version of your code run " mvn clean compile site ".

WARNINGS :

• the "projectVersion" declared in the pom of your project must match with the filename "src/main/resources/xradar/release{version}.properties" and the field "version.label={version}" declared inside the release{version}.properties file.
• for the first use, you have to put "sequence.id=1" in the release{version}.properties file.
• When using maven-xradar-plugin by calling mvn site, the Xradar report is added to the report section of the site. When calling xradar's goals, the Xradar report is produce on the same directory but is not added to the project's site generated.
• the maven-site language configuration doesn't work, so don't add the following :

  							
  <locales>...</locales>
  			
  						

• When using maven-xradar-plugin as a report plugin (using "mvn site" goal) in a multi-module project with custom configuration, xradar is not executed as the last for the child so the aggregation of reports is not complete. To avoid this issue you may call "mvn site" and then call "audit" and "dynamic" goals.

Setup Maven

On Linux :

                export MAVEN_OPTS='-Xmx512m'
            

On Windows :

                set MAVEN_OPTS='-Xmx512m'
            

Configure the plugin :

The plugin comes with a lot of possible option to configure:

				
<build>
  <sourceDirectory>path/to/source</sourceDirectory> <!--if different from src/main/java-->
  	<plugins>
  	  <plugin>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>
  	</plugins>
  </build> 
<reporting>
   <plugins>
       <plugin>
  	     <groupId>net.sf.xradar</groupId>
  		 <artifactId>maven-xradar-plugin</artifactId>
  		 <version>1.2.2</version>
  		 <configuration>
  		   <xradarTarget>${basedir}/releaseStatic/docs/</xradarTarget>
  		   <xradarConfig>${basedir}/etc/xradar-config-default.xml</xradarConfig>
  		   <xradarProperties>${basedir}/etc/default-release.properties</xradarProperties>
  		   <javadocEnabled>true</javadocEnabled>
  		   <debug>true</debug>
  		</configuration>
  	</plugin>
  </plugins>
</reporting>
			
			

You can change any of those parameters. Here is a quick ref:

plugins Supported :