Package io.fabric8.maven.docker.config

Class ConfigHelper

java.lang.Object

io.fabric8.maven.docker.config.ConfigHelper

public class ConfigHelper
extends Object

Utility class which helps in resolving, customizing, initializing and validating image configuration.

Since:

17/05/16

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigHelper.Customizer	Allow subclasses to customize the given set of image configurations.
static interface	ConfigHelper.NameFormatter	Format an image name by replacing certain placeholders
static interface	ConfigHelper.Resolver	A resolver can map one given image configuration to one or more image configurations This is e.g.

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXTERNALCONFIG_ACTIVATION_PROPERTY

Method Summary

Modifier and Type	Method	Description
static String	getExternalConfigActivationProperty(org.apache.maven.project.MavenProject project)
static String	initAndValidate(List<ImageConfiguration> images, String apiVersion, ConfigHelper.NameFormatter nameFormatter, Logger log)	Initialize and validate the configuration.
static boolean	matchesConfiguredImages(String imageList, ImageConfiguration imageConfig)
static List<ImageConfiguration>	resolveImages(Logger logger, List<ImageConfiguration> images, ConfigHelper.Resolver imageResolver, String imageNameFilter, ConfigHelper.Customizer imageCustomizer)	Resolve image with an external image resolver
static void	validateExternalPropertyActivation(org.apache.maven.project.MavenProject project, List<ImageConfiguration> images)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTERNALCONFIG_ACTIVATION_PROPERTY

public static final String EXTERNALCONFIG_ACTIVATION_PROPERTY

See Also:

Constant Field Values

Method Detail

resolveImages

public static List<ImageConfiguration> resolveImages(Logger logger,
                                                     List<ImageConfiguration> images,
                                                     ConfigHelper.Resolver imageResolver,
                                                     String imageNameFilter,
                                                     ConfigHelper.Customizer imageCustomizer)

Resolve image with an external image resolver

Parameters:

images - the original image config list (can be null)

imageResolver - the resolver used to extend on an image configuration

imageNameFilter - filter to select only certain image configurations with the given name

imageCustomizer - final customization hook for mangling the configuration

Returns:

a list of resolved and customized image configuration.

validateExternalPropertyActivation

public static void validateExternalPropertyActivation(org.apache.maven.project.MavenProject project,
                                                      List<ImageConfiguration> images)
                                               throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getExternalConfigActivationProperty

public static String getExternalConfigActivationProperty(org.apache.maven.project.MavenProject project)

initAndValidate

public static String initAndValidate(List<ImageConfiguration> images,
                                     String apiVersion,
                                     ConfigHelper.NameFormatter nameFormatter,
                                     Logger log)

Initialize and validate the configuration.

Parameters:

images - the images to check

apiVersion - the original API version intended to use

nameFormatter - formatter for image names

log - a logger for printing out diagnostic messages

Returns:

the minimal API Docker API required to be used for the given configuration.

matchesConfiguredImages

public static boolean matchesConfiguredImages(String imageList,
                                              ImageConfiguration imageConfig)