1 package org.apache.maven; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import org.apache.maven.execution.MavenSession; 23 24 /** 25 * Allows core extensions to participate in Maven build session lifecycle. 26 * 27 * All callback methods (will) follow beforeXXX/afterXXX naming pattern to 28 * indicate at what lifecycle point it is being called. 29 * 30 * @see <a href="http://maven.apache.org/examples/maven-3-lifecycle-extensions.html">example</a> 31 * @see <a href="http://jira.codehaus.org/browse/MNG-4224">MNG-4224</a> 32 * @since 3.0-alpha-3 33 */ 34 public abstract class AbstractMavenLifecycleParticipant 35 { 36 37 /** 38 * Invoked after all MavenProject instances have been created. 39 * 40 * This callback is intended to allow extensions to manipulate MavenProjects 41 * before they are sorted and actual build execution starts. 42 */ 43 public void afterProjectsRead( MavenSession session ) 44 throws MavenExecutionException 45 { 46 // do nothing 47 } 48 49 /** 50 * Invoked after MavenSession instance has been created. 51 * 52 * This callback is intended to allow extensions to inject execution properties, 53 * activate profiles and perform similar tasks that affect MavenProject 54 * instance construction. 55 */ 56 // TODO: This is too early for build extensions, so maybe just remove it? 57 public void afterSessionStart( MavenSession session ) 58 throws MavenExecutionException 59 { 60 // do nothing 61 } 62 63 /** 64 * Invoked after all projects were built. 65 * 66 * This callback is intended to allow extensions to perform cleanup of any 67 * allocated external resources after the build. It is invoked on best-effort 68 * basis and may be missed due to an Error or RuntimeException in Maven core 69 * code. 70 * @since 3.2.1, MNG-5389 71 */ 72 public void afterSessionEnd( MavenSession session ) 73 throws MavenExecutionException 74 { 75 // do nothing 76 } 77 }