maven, get execution id of goal at runtime in mojo execute()?

Question

Is there a way to get the current execution id of a goal at runtime from the mojo implementation?

I would like to use the execution id in the mojo code to avoid the need for an extra configuration parameter.

Here is an execution example:

<execution>
  <id>spring</id>
  <phase>generate-sources</phase>

  <configuration>
    <id>spring</id>  <!-- duplicate.. -->
    <apiPath>${project.basedir}/src/api/openapi.yaml</apiPath>
  </configuration>
           
  <goals>
    <goal>process</goal>
  </goals>
</execution>

Depending on the value of <id> the process mojo would run different code. I need the id to select the correct service (loaded with java.util.ServiceLoader).

Not sure if reusing the id is a good idea but I would like to know if it is possible at all? :-)

That means you want to couple the execution id to a configuration ? Sounds like a very bad idea... — khmarbaise, Jun 30 '20 at 13:57
That sounds like a method that behaves differently when you rename the parameter. — J Fabian Meier, Jun 30 '20 at 14:14
Why should anybody spend time to figure out a way if it's a bad idea? Furthermore, even if I knew, I would not write an answer. Other people might find it and think that is a good approach. — J Fabian Meier, Jun 30 '20 at 15:40
I just asked a question out of curiosity. If you don't like it, please ignore it. There is no reason to write an unfriendly comment. — Martin Hauner, Jul 02 '20 at 05:40

score 2 · Answer 1 · answered Jul 02 '20 at 21:33

I found the answer to my question in the AbstractCompilerMojo.java class of the maven-compiler-plugin. It declares the following @Parameter

@Parameter( defaultValue = "${mojoExecution}", readonly = true, required = true )
private MojoExecution mojoExecution;

The MojoExecution contains the execution id.

I do not recommend the original motivation of my question: to use the execution id for plugin internal logic.

It is usually not a good idea to re-use details like this for another purpose and apply a second meaning to an existing information. It is confusing and unexpected for someone not aware of it.

It's still a valuable piece of information, because the defaultValue of the @Parameter annotation allows other expressions that can be used by a plugin to access information about the project & the build.

maven, get execution id of goal at runtime in mojo execute()?

1 Answers1