View Javadoc

1   package org.apache.maven.plugin.checkstyle.rss;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.IOException;
23  
24  import org.apache.maven.plugin.MojoExecutionException;
25  import org.apache.maven.plugin.checkstyle.CheckstyleReport;
26  import org.apache.maven.plugin.checkstyle.CheckstyleResults;
27  import org.apache.maven.plugin.checkstyle.VelocityTemplate;
28  import org.apache.maven.reporting.MavenReportException;
29  import org.apache.velocity.VelocityContext;
30  import org.apache.velocity.context.Context;
31  import org.apache.velocity.exception.ResourceNotFoundException;
32  import org.apache.velocity.exception.VelocityException;
33  import org.codehaus.plexus.component.annotations.Component;
34  import org.codehaus.plexus.component.annotations.Requirement;
35  import org.codehaus.plexus.util.StringUtils;
36  import org.codehaus.plexus.velocity.VelocityComponent;
37  
38  import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
39  
40  /**
41   * @author Olivier Lamy
42   * @since 2.4
43   */
44  @Component( role = CheckstyleRssGenerator.class, hint = "default" )
45  public class DefaultCheckstyleRssGenerator
46      implements CheckstyleRssGenerator
47  {
48      @Requirement
49      private VelocityComponent velocityComponent;
50  
51      /**
52       * @see org.apache.maven.plugin.checkstyle.rss.CheckstyleRssGenerator#generateRSS(org.apache.maven.plugin.checkstyle.CheckstyleResults)
53       */
54      public void generateRSS( CheckstyleResults results, CheckstyleRssGeneratorRequest checkstyleRssGeneratorRequest )
55          throws MavenReportException
56      {
57  
58          VelocityTemplate vtemplate = new VelocityTemplate( velocityComponent, CheckstyleReport.PLUGIN_RESOURCES );
59          vtemplate.setLog( checkstyleRssGeneratorRequest.getLog() );
60  
61          Context context = new VelocityContext();
62          context.put( "results", results );
63          context.put( "project", checkstyleRssGeneratorRequest.getMavenProject() );
64          context.put( "copyright", checkstyleRssGeneratorRequest.getCopyright() );
65          context.put( "levelInfo", SeverityLevel.INFO );
66          context.put( "levelWarning", SeverityLevel.WARNING );
67          context.put( "levelError", SeverityLevel.ERROR );
68          context.put( "stringutils", new StringUtils() );
69  
70          try
71          {
72              vtemplate.generate( checkstyleRssGeneratorRequest.getOutputDirectory().getPath() + "/checkstyle.rss",
73                                  "checkstyle-rss.vm", context );
74          }
75          catch ( ResourceNotFoundException e )
76          {
77              throw new MavenReportException( "Unable to find checkstyle-rss.vm resource.", e );
78          }
79          catch ( MojoExecutionException e )
80          {
81              throw new MavenReportException( "Unable to generate checkstyle.rss.", e );
82          }
83          catch ( VelocityException e )
84          {
85              throw new MavenReportException( "Unable to generate checkstyle.rss.", e );
86          }
87          catch ( IOException e )
88          {
89              throw new MavenReportException( "Unable to generate checkstyle.rss.", e );
90          }
91      }
92      
93  }