com.itemis.maven.plugins.cdi.CDIMojoProcessingStep Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdi-plugin-utils Show documentation

Provides an abstract Mojo that enables CDI-based dependency injection for Maven Plugins.

There is a newer version: 3.4.0

package com.itemis.maven.plugins.cdi;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;

import com.itemis.maven.plugins.cdi.annotations.ProcessingStep;
import com.itemis.maven.plugins.cdi.annotations.RollbackOnError;

/**
 * Classes of this type will automatically be executed as the primary plugin code once the CDI container is set up and
 * the corresponding workflow for the goal is parsed.

 * You can influence the execution order of the processing steps using the workflow descriptor which references the ids
 * specified in the {@link ProcessingStep} annotation.

 * 

 *
 * Example Mojo:
 *
 *  * @ProcessingStep(id = "test", description = "any description of this step")
 * public class TestStep implements CDIMojoProcessingStep {
 *   @Inject
 *   @Named("sourcePath")
 *   private String sourcePath;
 *
 *   public void execute() throws MojoExecutionException, MojoFailureException {
 *     System.out.println(this.sourcePath);
 *   }
 * }
 * 
 *
 * @author Stanley Hillner
 * @since 1.0.0
 */
public interface CDIMojoProcessingStep {

  /**
   * The primary execution method which will be called as soon as this Mojo is ready for execution.

   * If the execution of this method fails with any kind of {@link Throwable}, the Mojo will automatically search for
   * all methods annotated with the {@link RollbackOnError}. If the specified throwable type matches and the method's
   * optional argument matches the caught Exception type, the rollback method will be executed. It is possible to
   * declare multiple rollback methods for a Processing Step.
   *
   * @throws MojoExecutionException if an unexpected execution exception occurred.
   * @throws MojoFailureException an expected exceptional case during the Mojo execution.
   */
  void execute() throws MojoExecutionException, MojoFailureException;
}