io.fabric8.maven.generator.api

Interface Generator

All Superinterfaces:

Named

All Known Implementing Classes:

BaseGenerator

public interface Generator
extends Named

Generator which can create ImageConfiguration on the fly by examining the build pom.xml

Since:

15/05/16

Author:

roland

Method Summary

Modifier and Type	Method and Description
List<io.fabric8.maven.docker.config.ImageConfiguration>	customize(List<io.fabric8.maven.docker.config.ImageConfiguration> existingConfigs, boolean prePackagePhase) Provide additional image configurations.
boolean	isApplicable(List<io.fabric8.maven.docker.config.ImageConfiguration> configs) Check whether this generator should kick in.

Methods inherited from interface io.fabric8.maven.core.config.Named

getName

Method Detail

isApplicable

boolean isApplicable(List<io.fabric8.maven.docker.config.ImageConfiguration> configs)
              throws org.apache.maven.plugin.MojoExecutionException

Check whether this generator should kick in. The check must not examing anything below `target/` as this can not be available when this is called in a pre package phase.

Parameters:

configs - all configuration already available

Returns:

true if the generator is applicable

Throws:

org.apache.maven.plugin.MojoExecutionException

customize

List<io.fabric8.maven.docker.config.ImageConfiguration> customize(List<io.fabric8.maven.docker.config.ImageConfiguration> existingConfigs,
                                                                  boolean prePackagePhase)
                                                           throws org.apache.maven.plugin.MojoExecutionException

Provide additional image configurations.

Parameters:

existingConfigs - the already detected and resolved configuration

prePackagePhase - if true this is called in a prepackage phase where no artifacts has been packaged in target/.

Returns:

list of image configurations

Throws:

org.apache.maven.plugin.MojoExecutionException