001package org.apache.maven;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *  http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.execution.MavenSession;
023
024/**
025 * Allows core extensions to participate in Maven build session lifecycle.
026 *
027 * All callback methods (will) follow beforeXXX/afterXXX naming pattern to
028 * indicate at what lifecycle point it is being called.
029 *
030 * @see <a href="http://maven.apache.org/examples/maven-3-lifecycle-extensions.html">example</a>
031 * @see <a href="http://jira.codehaus.org/browse/MNG-4224">MNG-4224</a>
032 * @since 3.0-alpha-3
033 */
034public abstract class AbstractMavenLifecycleParticipant
035{
036
037    /**
038     * Invoked after all MavenProject instances have been created.
039     *
040     * This callback is intended to allow extensions to manipulate MavenProjects
041     * before they are sorted and actual build execution starts.
042     */
043    public void afterProjectsRead( MavenSession session )
044        throws MavenExecutionException
045    {
046        // do nothing
047    }
048
049    /**
050     * Invoked after MavenSession instance has been created.
051     *
052     * This callback is intended to allow extensions to inject execution properties,
053     * activate profiles and perform similar tasks that affect MavenProject
054     * instance construction.
055     */
056    // TODO: This is too early for build extensions, so maybe just remove it?
057    public void afterSessionStart( MavenSession session )
058        throws MavenExecutionException
059    {
060        // do nothing
061    }
062
063    /**
064     * Invoked after all projects were built.
065     *
066     * This callback is intended to allow extensions to perform cleanup of any
067     * allocated external resources after the build. It is invoked on best-effort
068     * basis and may be missed due to an Error or RuntimeException in Maven core
069     * code.
070     * @since 3.2.1, MNG-5389
071     */
072    public void afterSessionEnd( MavenSession session )
073        throws MavenExecutionException
074    {
075        // do nothing
076    }
077}