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 build 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 */
031public abstract class AbstractMavenLifecycleParticipant
032{
033
034    /**
035     * Invoked after all MavenProject instances have been created.
036     *
037     * This callback is intended to allow extensions to manipulate MavenProjects
038     * before they are sorted and actual build execution starts.
039     */
040    public void afterProjectsRead( MavenSession session )
041        throws MavenExecutionException
042    {
043        // do nothing
044    }
045
046    /**
047     * Invoked after MavenSession instance has been created.
048     *
049     * This callback is intended to allow extensions to inject execution properties,
050     * activate profiles and perform similar tasks that affect MavenProject
051     * instance construction.
052     */
053    // TODO: This is too early for build extensions, so maybe just remove it?
054    public void afterSessionStart( MavenSession session )
055        throws MavenExecutionException
056    {
057        // do nothing
058    }
059
060    /**
061     * Invoked after all projects were built.
062     *
063     * This callback is intended to allow extensions to perform cleanup of any
064     * allocated external resources after the build. It is invoked on best-effort
065     * basis and may be missed due to an Error or RuntimeException in Maven core
066     * code.
067     */
068    public void afterSessionEnd( MavenSession session )
069        throws MavenExecutionException    
070    {
071        // do nothing
072    }
073}