001/* 002 * Copyright (C) Christian Schulte, 2005-206 003 * All rights reserved. 004 * 005 * Redistribution and use in source and binary forms, with or without 006 * modification, are permitted provided that the following conditions 007 * are met: 008 * 009 * o Redistributions of source code must retain the above copyright 010 * notice, this list of conditions and the following disclaimer. 011 * 012 * o Redistributions in binary form must reproduce the above copyright 013 * notice, this list of conditions and the following disclaimer in 014 * the documentation and/or other materials provided with the 015 * distribution. 016 * 017 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 018 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 019 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 020 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, 021 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 022 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 023 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 024 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 025 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 026 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 027 * 028 * $JOMC: AbstractClassesValidateMojo.java 4613 2012-09-22 10:07:08Z schulte $ 029 * 030 */ 031package org.jomc.mojo; 032 033import java.io.File; 034import java.util.logging.Level; 035import javax.xml.bind.JAXBContext; 036import javax.xml.bind.util.JAXBSource; 037import javax.xml.transform.Source; 038import org.apache.maven.plugin.MojoExecutionException; 039import org.jomc.model.Module; 040import org.jomc.modlet.ModelContext; 041import org.jomc.modlet.ModelValidationReport; 042import org.jomc.modlet.ObjectFactory; 043import org.jomc.tools.ClassFileProcessor; 044 045/** 046 * Base class for validating class file model objects. 047 * 048 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a> 049 * @version $JOMC: AbstractClassesValidateMojo.java 4613 2012-09-22 10:07:08Z schulte $ 050 */ 051public abstract class AbstractClassesValidateMojo extends AbstractJomcMojo 052{ 053 054 /** Constant for the name of the tool backing the mojo. */ 055 private static final String TOOLNAME = "ClassFileProcessor"; 056 057 /** Creates a new {@code AbstractClassesValidateMojo} instance. */ 058 public AbstractClassesValidateMojo() 059 { 060 super(); 061 } 062 063 @Override 064 protected final void executeTool() throws Exception 065 { 066 this.logSeparator(); 067 068 if ( this.isClassProcessingEnabled() ) 069 { 070 this.logProcessingModule( TOOLNAME, this.getClassesModuleName() ); 071 072 final ModelContext context = this.createModelContext( this.getClassesClassLoader() ); 073 final ClassFileProcessor tool = this.createClassFileProcessor( context ); 074 final JAXBContext jaxbContext = context.createContext( this.getModel() ); 075 final Source source = new JAXBSource( jaxbContext, new ObjectFactory().createModel( tool.getModel() ) ); 076 ModelValidationReport validationReport = context.validateModel( this.getModel(), source ); 077 this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport ); 078 079 if ( validationReport.isModelValid() ) 080 { 081 final Module module = 082 tool.getModules() != null ? tool.getModules().getModule( this.getClassesModuleName() ) : null; 083 084 if ( module != null ) 085 { 086 validationReport = tool.validateModelObjects( module, context, this.getClassesDirectory() ); 087 088 if ( validationReport != null ) 089 { 090 this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, 091 validationReport ); 092 093 if ( !validationReport.isModelValid() ) 094 { 095 throw new MojoExecutionException( Messages.getMessage( "classFileValidationFailure" ) ); 096 } 097 } 098 099 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}