io.fabric8.maven.enricher.api

Class BaseEnricher

java.lang.Object

io.fabric8.maven.enricher.api.BaseEnricher

All Implemented Interfaces:

Enricher

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	addDefaultResources(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 String	getExternalServiceURL(String serviceName, String protocol) Returns the external access to the given service name
protected List<io.fabric8.maven.docker.config.ImageConfiguration>	getImages()
protected io.fabric8.kubernetes.client.KubernetesClient	getKubernetes()
Map<String,String>	getLabels(Kind kind) Get labels to add too objects
protected io.fabric8.maven.docker.util.Logger	getLog()
String	getName() Unique name of the enricher
protected org.apache.maven.project.MavenProject	getProject()
Map<String,String>	getSelector(Kind kind) Get the selector for a service or replica set / replication controller
protected boolean	isOffline() Returns true if in offline 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()

Description copied from interface: Enricher

Unique name of the enricher

Specified by:

getName in interface Enricher

Returns:

enricher name

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

Specified by:

adapt in interface Enricher

Parameters:

builder - list to customer used to customize

addDefaultResources

public void addDefaultResources(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 whehter a default resource should be added

Specified by:

addDefaultResources 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()

isOffline

protected boolean isOffline()

Returns true if in offline mode

getKubernetes

protected io.fabric8.kubernetes.client.KubernetesClient getKubernetes()

getImages

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

getConfig

protected String getConfig(Configs.Key key)

getConfig

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

getContext

protected EnricherContext getContext()

getExternalServiceURL

protected String getExternalServiceURL(String serviceName,
                                       String protocol)

Returns the external access to the given service name

Parameters:

serviceName - name of the service

protocol - URL protocol such as http