1 /*
2 * Copyright (C) Christian Schulte <cs@schulte.it>, 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: AbstractClasspathValidateMojo.java 5043 2015-05-27 07:03:39Z schulte $
29 *
30 */
31 package org.jomc.mojo;
32
33 import java.util.logging.Level;
34 import javax.xml.bind.JAXBContext;
35 import javax.xml.bind.util.JAXBSource;
36 import javax.xml.transform.Source;
37 import org.apache.maven.plugin.MojoExecutionException;
38 import org.jomc.modlet.ModelContext;
39 import org.jomc.modlet.ModelValidationReport;
40 import org.jomc.modlet.ObjectFactory;
41 import org.jomc.tools.ClassFileProcessor;
42
43 /**
44 * Base class for validating class path class file model objects.
45 *
46 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
47 * @version $JOMC: AbstractClasspathValidateMojo.java 5043 2015-05-27 07:03:39Z schulte $
48 * @since 1.1
49 */
50 public abstract class AbstractClasspathValidateMojo extends AbstractJomcMojo
51 {
52
53 /**
54 * Constant for the name of the tool backing the mojo.
55 */
56 private static final String TOOLNAME = "ClassFileProcessor";
57
58 /**
59 * Creates a new {@code AbstractClasspathValidateMojo} instance.
60 */
61 public AbstractClasspathValidateMojo()
62 {
63 super();
64 }
65
66 @Override
67 protected final void executeTool() throws Exception
68 {
69 this.logSeparator();
70 this.logProcessingModel( TOOLNAME, this.getModel() );
71
72 final ModelContext context = this.createModelContext( this.getClasspathClassLoader() );
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
78 this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport );
79
80 if ( validationReport.isModelValid() )
81 {
82 validationReport = tool.validateModelObjects( context );
83
84 if ( validationReport != null )
85 {
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
94 this.logToolSuccess( TOOLNAME );
95 }
96 else
97 {
98 throw new MojoExecutionException( Messages.getMessage( "classFileValidationFailure" ) );
99 }
100 }
101
102 /**
103 * Gets the class loader to validate class path model objects of.
104 *
105 * @return The class loader to validate class path model objects of.
106 *
107 * @throws MojoExecutionException if getting the class loader fails.
108 */
109 protected abstract ClassLoader getClasspathClassLoader() throws MojoExecutionException;
110
111 }