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: MainModelValidateMojo.java 4613 2012-09-22 10:07:08Z schulte $
029 *
030 */
031package org.jomc.mojo;
032
033import java.util.logging.Level;
034import org.apache.maven.plugin.MojoExecutionException;
035import org.jomc.modlet.ModelContext;
036import org.jomc.modlet.ModelValidationReport;
037
038/**
039 * Validates a project's main model.
040 *
041 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
042 * @version $JOMC: MainModelValidateMojo.java 4613 2012-09-22 10:07:08Z schulte $
043 *
044 * @phase process-classes
045 * @goal validate-main-model
046 * @threadSafe
047 * @requiresDependencyResolution test
048 */
049public final class MainModelValidateMojo extends AbstractJomcMojo
050{
051
052    /** Constant for the name of the tool backing the mojo. */
053    private static final String TOOLNAME = "ModelValidator";
054
055    /**
056     * Execution strategy of the goal ({@code always} or {@code once-per-session}).
057     *
058     * @parameter default-value="once-per-session" expression="${jomc.validateMainModelExecutionStrategy}"
059     * @since 1.1
060     */
061    private String validateMainModelExecutionStrategy;
062
063    /** Creates a new {@code MainModelValidateMojo} instance. */
064    public MainModelValidateMojo()
065    {
066        super();
067    }
068
069    @Override
070    protected void executeTool() throws Exception
071    {
072        this.logSeparator();
073        this.logProcessingModel( TOOLNAME, this.getModel() );
074
075        final ModelContext context = this.createModelContext( this.getMainClassLoader() );
076        final ModelValidationReport validationReport = context.validateModel( this.getModel( context ) );
077
078        this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport );
079
080        if ( !validationReport.isModelValid() )
081        {
082            throw new MojoExecutionException( Messages.getMessage( "failedValidatingMainModel" ) );
083        }
084
085        this.logToolSuccess( TOOLNAME );
086    }
087
088    @Override
089    protected String getGoal() throws MojoExecutionException
090    {
091        return "validate-main-model";
092    }
093
094    @Override
095    protected String getExecutionStrategy() throws MojoExecutionException
096    {
097        return this.validateMainModelExecutionStrategy;
098    }
099
100}