io.fabric8.maven.enricher.api

Class BaseEnricher

java.lang.Object

io.fabric8.maven.enricher.api.BaseEnricher

All Implemented Interfaces:

Named, Enricher

Direct Known Subclasses:

AbstractHealthCheckEnricher, AbstractLiveEnricher

public abstract class BaseEnricher
extends Object
implements Enricher

Since:

01/04/16

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
protected io.fabric8.maven.docker.util.Logger	log

Constructor Summary

Constructors

Constructor and Description
BaseEnricher(EnricherContext buildContext, String name)

Method Summary

Modifier and Type	Method and Description
void	adapt(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder) Final customization of the overall resource descriptor.
void	addMissingResources(io.fabric8.kubernetes.api.model.KubernetesListBuilder builder) Add default resources when they are missing.
Map<String,String>	getAnnotations(Kind kind) Return annotations to add
protected String	getConfig(Configs.Key key)
protected String	getConfig(Configs.Key key, String defaultVal)
protected EnricherContext	getContext()
protected List<io.fabric8.maven.docker.config.ImageConfiguration>	getImages()
Map<String,String>	getLabels(Kind kind) Get labels to add too objects
protected io.fabric8.maven.docker.util.Logger	getLog()
String	getName()
protected org.apache.maven.project.MavenProject	getProject()
protected Map<String,String>	getRawConfig()
Map<String,String>	getSelector(Kind kind) Get the selector for a service or replica set / replication controller
protected boolean	hasConfig(Configs.Key key)
protected boolean	hasImageConfiguration()
protected boolean	isOpenShiftMode() Returns true if we are in OpenShift S2I binary building mode

Methods inherited from class java.lang.Object

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

Field Detail

log

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

Constructor Detail

BaseEnricher

public BaseEnricher(EnricherContext buildContext,
                    String name)

Method Detail

getName

public String getName()

Specified by:

getName in interface Named

getLabels

public Map<String,String> getLabels(Kind kind)

Description copied from interface: Enricher

Get labels to add too objects

Specified by:

getLabels in interface Enricher

Parameters:

kind - for which type to get the labels

Returns:

map of additional labels

getAnnotations

public Map<String,String> getAnnotations(Kind kind)

Description copied from interface: Enricher

Return annotations to add

Specified by:

getAnnotations in interface Enricher

Parameters:

kind - the kind of object to add

Returns:

map of annotations

adapt

public void adapt(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:

adapt in interface Enricher

Parameters:

builder - list to customer used to customize

addMissingResources

public void addMissingResources(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:

addMissingResources in interface Enricher

Parameters:

builder - the build to examine and add to

getSelector

public Map<String,String> getSelector(Kind kind)

Description copied from interface: Enricher

Get the selector for a service or replica set / replication controller

Specified by:

getSelector in interface Enricher

Parameters:

kind - get the selector map

Returns:

selector

getProject

protected org.apache.maven.project.MavenProject getProject()

getLog

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

getImages

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

hasImageConfiguration

protected boolean hasImageConfiguration()

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