io.fabric8.maven.enricher.api

Class MavenEnricherContext

java.lang.Object

io.fabric8.maven.enricher.api.MavenEnricherContext

All Implemented Interfaces:

EnricherContext

public class MavenEnricherContext
extends Object
implements EnricherContext

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

Since:

01/04/16

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MavenEnricherContext.Builder

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
String	getDockerJsonConfigString(org.apache.maven.settings.Settings settings, String serverId)
GroupArtifactVersion	getGav() Get the current artifact with its parameters
io.fabric8.maven.docker.util.Logger	getLog() Get Logger.
Map<String,String>	getProcessingInstructions()
org.apache.maven.project.MavenProject	getProject()
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.
org.apache.maven.settings.Server	getServer(org.apache.maven.settings.Settings settings, String serverId)
org.apache.maven.settings.Settings	getSettings()
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> instruction)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.fabric8.maven.enricher.api.EnricherContext

getDependencyVersion, hasDependency

Method Detail

getConfiguration

public Configuration getConfiguration()

Description copied from interface: EnricherContext

The configuration specific to the enricher.

Specified by:

getConfiguration in interface EnricherContext

Returns:

configuration to use

getSettings

public org.apache.maven.settings.Settings getSettings()

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

getLog

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

Description copied from interface: EnricherContext

Get Logger.

Specified by:

getLog in interface EnricherContext

Returns:

Logger.

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

resolvePath

public Path resolvePath(String path)

Description copied from interface: EnricherContext

Resolves the path string against the project directory

Specified by:

resolvePath in interface EnricherContext

Parameters:

path - the path string to resolve

Returns:

the resulting path

See Also:

Path.resolve(String)

getDependencies

public List<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 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

getProperty

public Object getProperty(String key)

Description copied from interface: EnricherContext

Gets a system property used in project.

Specified by:

getProperty in interface EnricherContext

Parameters:

key - name of property

Returns:

value of property if set.

getProject

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

getDockerJsonConfigString

public String getDockerJsonConfigString(org.apache.maven.settings.Settings settings,
                                        String serverId)

getServer

public org.apache.maven.settings.Server getServer(org.apache.maven.settings.Settings settings,
                                                  String serverId)