org.eclipse.jkube.kit.enricher.api

Class JKubeEnricherContext

java.lang.Object

org.eclipse.jkube.kit.enricher.api.JKubeEnricherContext

All Implemented Interfaces:

EnricherContext

public class JKubeEnricherContext
extends Object
implements EnricherContext

The context given to each enricher from where it can extract build specific information.

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JKubeEnricherContext.JKubeEnricherContextBuilder

Constructor Summary

Constructors

Constructor and Description
JKubeEnricherContext(Configuration configuration, List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> settings, Map<String,String> processingInstructions, org.eclipse.jkube.kit.common.JavaProject project, org.eclipse.jkube.kit.common.KitLogger log, ResourceConfig resources, List<ImageConfiguration> images, ProcessorConfig processorConfig, HandlerHub handlerHub, JKubeBuildStrategy jKubeBuildStrategy)
JKubeEnricherContext(List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> settings, Map<String,String> processingInstructions, org.eclipse.jkube.kit.common.JavaProject project, org.eclipse.jkube.kit.common.KitLogger log, ResourceConfig resources, List<ImageConfiguration> images, ProcessorConfig processorConfig, JKubeBuildStrategy jKubeBuildStrategy)

Method Summary

Modifier and Type	Method and Description
static JKubeEnricherContext.JKubeEnricherContextBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Configuration	getConfiguration() overall configuration for the build.
List<org.eclipse.jkube.kit.common.Dependency>	getDependencies(boolean transitive) Gets dependencies defined in build tool
String	getDockerJsonConfigString(List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> settings, String serverId)
GroupArtifactVersion	getGav() Get the current artifact with its parameters
HandlerHub	getHandlerHub() Returns the global Handler Hub to use with the enrichers.
org.eclipse.jkube.kit.common.KitLogger	getLog() Get Logger.
Map<String,String>	getProcessingInstructions()
org.eclipse.jkube.kit.common.JavaProject	getProject()
org.eclipse.jkube.kit.common.util.ProjectClassLoaders	getProjectClassLoaders() Get various class loaders used in the projects
File	getProjectDirectory() Base directory of the project.
Properties	getProperties() Returns the properties applicable for this EnricherContext.
String	getProperty(String key) Gets a property used in project.
List<org.eclipse.jkube.kit.common.RegistryServerConfiguration>	getSettings()
int	hashCode()
boolean	hasPlugin(String groupId, String artifactId) Check if a given plugin is present
void	setProcessingInstructions(Map<String,String> instruction)
JKubeEnricherContext.JKubeEnricherContextBuilder	toBuilder()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jkube.kit.enricher.api.EnricherContext

getDependencyVersion, hasDependency

Constructor Detail

JKubeEnricherContext

public JKubeEnricherContext(List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> settings,
                            Map<String,String> processingInstructions,
                            org.eclipse.jkube.kit.common.JavaProject project,
                            org.eclipse.jkube.kit.common.KitLogger log,
                            ResourceConfig resources,
                            List<ImageConfiguration> images,
                            ProcessorConfig processorConfig,
                            JKubeBuildStrategy jKubeBuildStrategy)

JKubeEnricherContext

public JKubeEnricherContext(Configuration configuration,
                            List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> settings,
                            Map<String,String> processingInstructions,
                            org.eclipse.jkube.kit.common.JavaProject project,
                            org.eclipse.jkube.kit.common.KitLogger log,
                            ResourceConfig resources,
                            List<ImageConfiguration> images,
                            ProcessorConfig processorConfig,
                            HandlerHub handlerHub,
                            JKubeBuildStrategy jKubeBuildStrategy)

Method Detail

getProcessingInstructions

public Map<String,String> getProcessingInstructions()

Specified by:

getProcessingInstructions in interface EnricherContext

setProcessingInstructions

public void setProcessingInstructions(Map<String,String> instruction)

Specified by:

setProcessingInstructions in interface EnricherContext

getGav

public GroupArtifactVersion getGav()

Description copied from interface: EnricherContext

Get the current artifact with its parameters

Specified by:

getGav in interface EnricherContext

Returns:

the artifact

getProjectDirectory

public File getProjectDirectory()

Description copied from interface: EnricherContext

Base directory of the project. E.g. for Maven that's the directory where the pom.xml is placed in

Specified by:

getProjectDirectory in interface EnricherContext

Returns:

the projects based directory

getDependencies

public List<org.eclipse.jkube.kit.common.Dependency> getDependencies(boolean transitive)

Description copied from interface: EnricherContext

Gets dependencies defined in build tool

Specified by:

getDependencies in interface EnricherContext

Parameters:

transitive - if transitive deps should be returned.

Returns:

List of dependencies.

hasPlugin

public boolean hasPlugin(String groupId,
                         String artifactId)

Description copied from interface: EnricherContext

Check if a given plugin is present

Specified by:

hasPlugin in interface EnricherContext

Parameters:

groupId - group id of plugin to check. If null any group will be considered.

artifactId - of plugin to check

Returns:

true if a plugin exists, false otherwise.

getProjectClassLoaders

public org.eclipse.jkube.kit.common.util.ProjectClassLoaders getProjectClassLoaders()

Description copied from interface: EnricherContext

Get various class loaders used in the projects

Specified by:

getProjectClassLoaders in interface EnricherContext

Returns:

compile and test class loader

getProperties

public Properties getProperties()

Description copied from interface: EnricherContext

Returns the properties applicable for this EnricherContext.

Specified by:

getProperties in interface EnricherContext

Returns:

properties for the context

getProperty

public String getProperty(String key)

Description copied from interface: EnricherContext

Gets a property used in project.

Specified by:

getProperty in interface EnricherContext

Parameters:

key - name of property

Returns:

value of property if set.

getDockerJsonConfigString

public String getDockerJsonConfigString(List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> settings,
                                        String serverId)

builder

public static JKubeEnricherContext.JKubeEnricherContextBuilder builder()

toBuilder

public JKubeEnricherContext.JKubeEnricherContextBuilder toBuilder()

getConfiguration

public Configuration getConfiguration()

overall configuration for the build.

Specified by:

getConfiguration in interface EnricherContext

Returns:

configuration to use

getSettings

public List<org.eclipse.jkube.kit.common.RegistryServerConfiguration> getSettings()

getProject

public org.eclipse.jkube.kit.common.JavaProject getProject()

Specified by:

getProject in interface EnricherContext

getLog

public org.eclipse.jkube.kit.common.KitLogger getLog()

Description copied from interface: EnricherContext

Get Logger.

Specified by:

getLog in interface EnricherContext

Returns:

Logger.

getHandlerHub

public HandlerHub getHandlerHub()

Description copied from interface: EnricherContext

Returns the global Handler Hub to use with the enrichers.

Specified by:

getHandlerHub in interface EnricherContext

Returns:

the Handler Hub instance.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object