io.fabric8.maven.docker.config.handler

Interface ExternalConfigHandler

All Known Implementing Classes:

DockerComposeConfigHandler, PropertyConfigHandler

public interface ExternalConfigHandler

Interface which needs to be implemented to create image configurations from external sources

Since:

18/11/14

Author:

roland

Method Summary

Modifier and Type	Method and Description
String	getType() Get the unique type of this plugin as referenced with the <type> tag within a <reference> configuration section
List<ImageConfiguration>	resolve(ImageConfiguration unresolvedConfig, org.apache.maven.project.MavenProject project, org.apache.maven.execution.MavenSession session) For the given plugin configuration (which also contains the type) extract one or more ImageConfiguration objects describing the image to manage

Method Detail

getType

String getType()

Get the unique type of this plugin as referenced with the <type> tag within a <reference> configuration section

Returns:

plugin type

resolve

List<ImageConfiguration> resolve(ImageConfiguration unresolvedConfig,
                                 org.apache.maven.project.MavenProject project,
                                 org.apache.maven.execution.MavenSession session)
                          throws ExternalConfigHandlerException

For the given plugin configuration (which also contains the type) extract one or more ImageConfiguration objects describing the image to manage

Parameters:

unresolvedConfig - the original, unresolved config

project - maven project

session - maven session

Returns:

list of image configuration. Must not be null but can be empty.

Throws:

ExternalConfigHandlerException - if there is a problem resolving the image configuration