View Javadoc

1   /*
2    *   Copyright (C) Christian Schulte, 2005-206
3    *   All rights reserved.
4    *
5    *   Redistribution and use in source and binary forms, with or without
6    *   modification, are permitted provided that the following conditions
7    *   are met:
8    *
9    *     o Redistributions of source code must retain the above copyright
10   *       notice, this list of conditions and the following disclaimer.
11   *
12   *     o Redistributions in binary form must reproduce the above copyright
13   *       notice, this list of conditions and the following disclaimer in
14   *       the documentation and/or other materials provided with the
15   *       distribution.
16   *
17   *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18   *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19   *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20   *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21   *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   *
28   *   $JOMC: AbstractClassesValidateMojo.java 3838 2011-10-08 20:15:41Z schulte2005 $
29   *
30   */
31  package org.jomc.mojo;
32  
33  import java.io.File;
34  import java.util.logging.Level;
35  import javax.xml.bind.JAXBContext;
36  import javax.xml.bind.util.JAXBSource;
37  import javax.xml.transform.Source;
38  import org.apache.maven.plugin.MojoExecutionException;
39  import org.jomc.model.Module;
40  import org.jomc.modlet.ModelContext;
41  import org.jomc.modlet.ModelValidationReport;
42  import org.jomc.modlet.ObjectFactory;
43  import org.jomc.tools.ClassFileProcessor;
44  
45  /**
46   * Base class for validating class file model objects.
47   *
48   * @author <a href="mailto:schulte2005@users.sourceforge.net">Christian Schulte</a>
49   * @version $JOMC: AbstractClassesValidateMojo.java 3838 2011-10-08 20:15:41Z schulte2005 $
50   */
51  public abstract class AbstractClassesValidateMojo extends AbstractJomcMojo
52  {
53  
54      /** Constant for the name of the tool backing the mojo. */
55      private static final String TOOLNAME = "ClassFileProcessor";
56  
57      /** Creates a new {@code AbstractClassesValidateMojo} instance. */
58      public AbstractClassesValidateMojo()
59      {
60          super();
61      }
62  
63      @Override
64      protected final void executeTool() throws Exception
65      {
66          this.logSeparator();
67  
68          if ( this.isClassProcessingEnabled() )
69          {
70              this.logProcessingModule( TOOLNAME, this.getClassesModuleName() );
71  
72              final ModelContext context = this.createModelContext( this.getClassesClassLoader() );
73              final ClassFileProcessor tool = this.createClassFileProcessor( context );
74              final JAXBContext jaxbContext = context.createContext( this.getModel() );
75              final Source source = new JAXBSource( jaxbContext, new ObjectFactory().createModel( tool.getModel() ) );
76              ModelValidationReport validationReport = context.validateModel( this.getModel(), source );
77              this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport );
78  
79              if ( validationReport.isModelValid() )
80              {
81                  final Module module = tool.getModules().getModule( this.getClassesModuleName() );
82  
83                  if ( module != null )
84                  {
85                      validationReport = tool.validateModelObjects( module, context, this.getClassesDirectory() );
86                      this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport );
87  
88                      if ( !validationReport.isModelValid() )
89                      {
90                          throw new MojoExecutionException( Messages.getMessage( "classFileValidationFailure" ) );
91                      }
92  
93                      this.logToolSuccess( TOOLNAME );
94                  }
95                  else
96                  {
97                      this.logMissingModule( this.getClassesModuleName() );
98                  }
99              }
100             else
101             {
102                 throw new MojoExecutionException( Messages.getMessage( "classFileValidationFailure" ) );
103             }
104         }
105         else if ( this.isLoggable( Level.INFO ) )
106         {
107             this.log( Level.INFO, Messages.getMessage( "classFileValidationDisabled" ), null );
108         }
109     }
110 
111     /**
112      * Gets the name of the module to validate class file model objects of.
113      *
114      * @return The name of the module to validate class file model objects of.
115      *
116      * @throws MojoExecutionException if getting the name fails.
117      */
118     protected abstract String getClassesModuleName() throws MojoExecutionException;
119 
120     /**
121      * Gets the class loader to use for validating class file model objects.
122      *
123      * @return The class loader to use for validating class file model objects.
124      *
125      * @throws MojoExecutionException if getting the class loader fails.
126      */
127     protected abstract ClassLoader getClassesClassLoader() throws MojoExecutionException;
128 
129     /**
130      * Gets the directory holding the class files to validate model objects of.
131      *
132      * @return The directory holding the class files to validate model objects of.
133      *
134      * @throws MojoExecutionException if getting the directory fails.
135      */
136     protected abstract File getClassesDirectory() throws MojoExecutionException;
137 
138 }