io.fabric8.maven.enricher.api

Class BaseEnricher

java.lang.Object

io.fabric8.maven.enricher.api.BaseEnricher

All Implemented Interfaces:

Named, Enricher

public class BaseEnricher
extends Object
implements Enricher

Since:

01/04/16

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ENRICH_ALL_WITH_IMAGE_TRIGGERS
protected EnricherContext	enricherContext
protected static String	FABRIC8_GENERATED_CONTAINERS
protected static String	GENERATE_ROUTE
protected static String	IMAGE_CHANGE_TRIGGERS
protected io.fabric8.maven.docker.util.Logger	log
protected static String	NEED_IMAGECHANGE_TRIGGERS
static String	OPENSHIFT_DEPLOY_TIMEOUT_SECONDS
protected static String	OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER
protected static String	OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC
protected static String	SIDECAR

Constructor Summary

Constructors

Constructor and Description
BaseEnricher(EnricherContext enricherContext, String name)

Method Summary

Modifier and Type	Method and Description
void	create(PlatformMode platformMode, io.fabric8.kubernetes.api.model.KubernetesListBuilder builder) Add default resources when they are missing.
void	enrich(PlatformMode platformMode, io.fabric8.kubernetes.api.model.KubernetesListBuilder builder) Final customization of the overall resource descriptor.
protected String	getConfig(Configs.Key key)
protected String	getConfig(Configs.Key key, String defaultVal)
protected Configuration	getConfiguration()
protected EnricherContext	getContext()
protected String	getImagePullPolicy(ResourceConfig resourceConfig, String defaultValue) This method overrides the ImagePullPolicy value by the value provided in XML config.
protected Optional<List<io.fabric8.maven.docker.config.ImageConfiguration>>	getImages()
protected io.fabric8.maven.docker.util.Logger	getLog()
String	getName()
protected Long	getOpenshiftDeployTimeoutInSeconds(Long defaultValue)
protected List<String>	getProcessingInstructionViaKey(String key)
protected Map<String,String>	getRawConfig()
protected int	getReplicaCount(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder, ResourceConfig xmlResourceConfig, int defaultValue) This method just makes sure that the replica count provided in XML config overrides the default option; and resource fragments are always given topmost priority.
protected Boolean	getValueFromConfig(String propertyName, Boolean defaultValue)
protected String	getValueFromConfig(String propertyName, String defaultValue)
protected boolean	hasConfig(Configs.Key key)
protected boolean	hasImageConfiguration()
protected boolean	isOpenShiftMode() Returns true if we are in OpenShift S2I binary building mode
protected void	setProcessingInstruction(String key, List<String> containerNames)
protected boolean	useDeploymentforOpenShift()

Methods inherited from class java.lang.Object

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

Field Detail

OPENSHIFT_DEPLOY_TIMEOUT_SECONDS

public static final String OPENSHIFT_DEPLOY_TIMEOUT_SECONDS

See Also:

Constant Field Values

enricherContext

protected EnricherContext enricherContext

FABRIC8_GENERATED_CONTAINERS

protected static final String FABRIC8_GENERATED_CONTAINERS

See Also:

Constant Field Values

NEED_IMAGECHANGE_TRIGGERS

protected static final String NEED_IMAGECHANGE_TRIGGERS

See Also:

Constant Field Values

IMAGE_CHANGE_TRIGGERS

protected static final String IMAGE_CHANGE_TRIGGERS

See Also:

Constant Field Values

OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC

protected static final String OPENSHIFT_TRIM_IMAGE_IN_CONTAINER_SPEC

See Also:

Constant Field Values

OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER

protected static final String OPENSHIFT_ENABLE_AUTOMATIC_TRIGGER

See Also:

Constant Field Values

SIDECAR

protected static final String SIDECAR

See Also:

Constant Field Values

ENRICH_ALL_WITH_IMAGE_TRIGGERS

protected static final String ENRICH_ALL_WITH_IMAGE_TRIGGERS

See Also:

Constant Field Values

GENERATE_ROUTE

protected static final String GENERATE_ROUTE

See Also:

Constant Field Values

log

protected io.fabric8.maven.docker.util.Logger log

Constructor Detail

BaseEnricher

public BaseEnricher(EnricherContext enricherContext,
                    String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface Named

enrich

public void enrich(PlatformMode platformMode,
                   io.fabric8.kubernetes.api.model.KubernetesListBuilder builder)

Description copied from interface: Enricher

Final customization of the overall resource descriptor. Fine tuning happens here.

Specified by:

enrich in interface Enricher

builder - list to customer used to customize

create

public void create(PlatformMode platformMode,
                   io.fabric8.kubernetes.api.model.KubernetesListBuilder builder)

Description copied from interface: Enricher

Add default resources when they are missing. Each enricher should be responsible for a certain kind of resource and should detect whether a default resource should be added. This should be done defensive, so that when an object is already set it must not be overwritten. This method is only called on resources which are associated with the artefact to build. This is determined that the resource is named like the artifact to build.

Specified by:

create in interface Enricher

builder - the build to examine and add to

getLog

protected io.fabric8.maven.docker.util.Logger getLog()

getImages

protected Optional<List<io.fabric8.maven.docker.config.ImageConfiguration>> getImages()

hasImageConfiguration

protected boolean hasImageConfiguration()

getConfiguration

protected Configuration getConfiguration()

getConfig

protected String getConfig(Configs.Key key)

hasConfig

protected boolean hasConfig(Configs.Key key)

getConfig

protected String getConfig(Configs.Key key,
                           String defaultVal)

getRawConfig

protected Map<String,String> getRawConfig()

getContext

protected EnricherContext getContext()

isOpenShiftMode

protected boolean isOpenShiftMode()

Returns true if we are in OpenShift S2I binary building mode

getProcessingInstructionViaKey

protected List<String> getProcessingInstructionViaKey(String key)

getOpenshiftDeployTimeoutInSeconds

protected Long getOpenshiftDeployTimeoutInSeconds(Long defaultValue)

getImagePullPolicy

protected String getImagePullPolicy(ResourceConfig resourceConfig,
                                    String defaultValue)

This method overrides the ImagePullPolicy value by the value provided in XML config.

Parameters:

resourceConfig -

defaultValue -

Returns:

getReplicaCount

protected int getReplicaCount(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder,
                              ResourceConfig xmlResourceConfig,
                              int defaultValue)

This method just makes sure that the replica count provided in XML config overrides the default option; and resource fragments are always given topmost priority.

Parameters:

builder -

xmlResourceConfig -

defaultValue -

Returns:

resolved replica count

setProcessingInstruction

protected void setProcessingInstruction(String key,
                                        List<String> containerNames)

useDeploymentforOpenShift

protected boolean useDeploymentforOpenShift()

getValueFromConfig

protected Boolean getValueFromConfig(String propertyName,
                                     Boolean defaultValue)

getValueFromConfig

protected String getValueFromConfig(String propertyName,
                                    String defaultValue)