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 4613 2012-09-22 10:07:08Z schulte $
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:cs@schulte.it">Christian Schulte</a>
49 * @version $JOMC: AbstractClassesValidateMojo.java 4613 2012-09-22 10:07:08Z schulte $
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 =
82 tool.getModules() != null ? tool.getModules().getModule( this.getClassesModuleName() ) : null;
83
84 if ( module != null )
85 {
86 validationReport = tool.validateModelObjects( module, context, this.getClassesDirectory() );
87
88 if ( validationReport != null )
89 {
90 this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE,
91 validationReport );
92
93 if ( !validationReport.isModelValid() )
94 {
95 throw new MojoExecutionException( Messages.getMessage( "classFileValidationFailure" ) );
96 }
97 }
98
99 this.logToolSuccess( TOOLNAME );
100 }
101 else
102 {
103 this.logMissingModule( this.getClassesModuleName() );
104 }
105 }
106 else
107 {
108 throw new MojoExecutionException( Messages.getMessage( "classFileValidationFailure" ) );
109 }
110 }
111 else if ( this.isLoggable( Level.INFO ) )
112 {
113 this.log( Level.INFO, Messages.getMessage( "classFileValidationDisabled" ), null );
114 }
115 }
116
117 /**
118 * Gets the name of the module to validate class file model objects of.
119 *
120 * @return The name of the module to validate class file model objects of.
121 *
122 * @throws MojoExecutionException if getting the name fails.
123 */
124 protected abstract String getClassesModuleName() throws MojoExecutionException;
125
126 /**
127 * Gets the class loader to use for validating class file model objects.
128 *
129 * @return The class loader to use for validating class file model objects.
130 *
131 * @throws MojoExecutionException if getting the class loader fails.
132 */
133 protected abstract ClassLoader getClassesClassLoader() throws MojoExecutionException;
134
135 /**
136 * Gets the directory holding the class files to validate model objects of.
137 *
138 * @return The directory holding the class files to validate model objects of.
139 *
140 * @throws MojoExecutionException if getting the directory fails.
141 */
142 protected abstract File getClassesDirectory() throws MojoExecutionException;
143
144 }