001/*
002 *   Copyright (C) 2005 Christian Schulte <cs@schulte.it>
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: AbstractSourcesManageMojo.java 5135 2016-04-08 13:53:07Z 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.SourceFileProcessor;
044
045/**
046 * Base class for managing source code files.
047 *
048 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
049 * @version $JOMC: AbstractSourcesManageMojo.java 5135 2016-04-08 13:53:07Z schulte $
050 */
051public abstract class AbstractSourcesManageMojo extends AbstractJomcMojo
052{
053
054    /**
055     * Constant for the name of the tool backing the class.
056     */
057    private static final String TOOLNAME = "SourceFileProcessor";
058
059    /**
060     * Creates a new {@code AbstractSourcesManageMojo} instance.
061     */
062    public AbstractSourcesManageMojo()
063    {
064        super();
065    }
066
067    @Override
068    protected final void executeTool() throws Exception
069    {
070        this.logSeparator();
071
072        if ( this.isSourceProcessingEnabled() )
073        {
074            this.logProcessingModule( TOOLNAME, this.getSourcesModuleName() );
075
076            final ModelContext context = this.createModelContext( this.getSourcesClassLoader() );
077            final SourceFileProcessor tool = this.createSourceFileProcessor( context );
078            final JAXBContext jaxbContext = context.createContext( this.getModel() );
079            final Source source = new JAXBSource( jaxbContext, new ObjectFactory().createModel( tool.getModel() ) );
080            final ModelValidationReport validationReport = context.validateModel( this.getModel(), source );
081
082            this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport );
083
084            if ( validationReport.isModelValid() )
085            {
086                final Module module =
087                    tool.getModules() != null ? tool.getModules().getModule( this.getSourcesModuleName() ) : null;
088
089                if ( module != null )
090                {
091                    tool.manageSourceFiles( module, this.getSourcesDirectory() );
092                    this.logToolSuccess( TOOLNAME );
093                }
094                else
095                {
096                    this.logMissingModule( this.getSourcesModuleName() );
097                }
098            }
099            else
100            {
101                throw new MojoExecutionException( Messages.getMessage( "sourceProcessingFailure" ) );
102            }
103        }
104        else if ( this.isLoggable( Level.INFO ) )
105        {
106            this.log( Level.INFO, Messages.getMessage( "sourceProcessingDisabled" ), null );
107        }
108    }
109
110    /**
111     * Gets the name of the module to manage source code files of.
112     *
113     * @return The name of the module to manage source code files of.
114     *
115     * @throws MojoExecutionException if getting the name fails.
116     */
117    protected abstract String getSourcesModuleName() throws MojoExecutionException;
118
119    /**
120     * Gets the class loader to use for managing source code files.
121     *
122     * @return The class loader to use for managing source code files.
123     *
124     * @throws MojoExecutionException if getting the class loader fails.
125     */
126    protected abstract ClassLoader getSourcesClassLoader() throws MojoExecutionException;
127
128    /**
129     * Gets the directory holding the source code files to manage.
130     *
131     * @return The directory holding the source code files to manage.
132     *
133     * @throws MojoExecutionException if getting the directory fails.
134     */
135    protected abstract File getSourcesDirectory() throws MojoExecutionException;
136
137}