io.fabric8.maven.enricher.api

Interface EnricherContext

All Known Implementing Classes:

MavenEnricherContext

public interface EnricherContext

Method Summary

Modifier and Type	Method and Description
Configuration	getConfiguration() The configuration specific to the enricher.
List<Dependency>	getDependencies(boolean transitive) Gets dependencies defined in build tool
default Optional<String>	getDependencyVersion(String groupId, String artifactId) Gets version of given dependency.
GroupArtifactVersion	getGav() Get the current artifact with its parameters
io.fabric8.maven.docker.util.Logger	getLog() Get Logger.
Map<String,String>	getProcessingInstructions()
ProjectClassLoaders	getProjectClassLoaders() Get various class loaders used in the projects
File	getProjectDirectory() Base directory of the project.
Object	getProperty(String key) Gets a system property used in project.
default boolean	hasDependency(String groupId, String artifactId) Checks if given dependency is defined.
boolean	hasPlugin(String groupId, String artifactId) Check if a given plugin is present
Path	resolvePath(String path) Resolves the path string against the project directory
void	setProcessingInstructions(Map<String,String> instructions)

Method Detail

getGav

GroupArtifactVersion getGav()

Get the current artifact with its parameters

Returns:

the artifact

getLog

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

Get Logger.

Returns:

Logger.

getConfiguration

Configuration getConfiguration()

The configuration specific to the enricher.

Returns:

configuration to use

getProcessingInstructions

Map<String,String> getProcessingInstructions()

setProcessingInstructions

void setProcessingInstructions(Map<String,String> instructions)

getProjectDirectory

File getProjectDirectory()

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

Returns:

the projects based directory

resolvePath

Path resolvePath(String path)

Resolves the path string against the project directory

Parameters:

path - the path string to resolve

Returns:

the resulting path

See Also:

Path.resolve(String)

getProjectClassLoaders

ProjectClassLoaders getProjectClassLoaders()

Get various class loaders used in the projects

Returns:

compile and test class loader

hasPlugin

boolean hasPlugin(String groupId,
                  String artifactId)

Check if a given plugin is present

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.

getDependencies

List<Dependency> getDependencies(boolean transitive)

Gets dependencies defined in build tool

Parameters:

transitive - if transitive deps should be returned.

Returns:

List of dependencies.

hasDependency

default boolean hasDependency(String groupId,
                              String artifactId)

Checks if given dependency is defined.

Parameters:

groupId - of dependency.

artifactId - of dependency. If null, check if there is any dependency with the given group

Returns:

True if present, false otherwise.

getDependencyVersion

default Optional<String> getDependencyVersion(String groupId,
                                              String artifactId)

Gets version of given dependency.

Parameters:

groupId - of the dependency.

artifactId - of the dependency.

Returns:

Version number.

getProperty

Object getProperty(String key)

Gets a system property used in project.

Parameters:

key - name of property

Returns:

value of property if set.