com.google.cloud.tools.jib.maven

Class MavenProjectProperties

java.lang.Object

com.google.cloud.tools.jib.maven.MavenProjectProperties

All Implemented Interfaces:

ProjectProperties

public class MavenProjectProperties
extends Object
implements ProjectProperties

Obtains information about a MavenProject.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_KEY Used to identify this plugin when interacting with the maven system.
static String	PLUGIN_NAME Used for logging during main class inference and analysis of user configuration.

Fields inherited from interface com.google.cloud.tools.jib.plugins.common.ProjectProperties

CACHE_DIRECTORY_NAME, EXPLODED_WAR_DIRECTORY_NAME

Method Summary

Modifier and Type	Method and Description
JibContainerBuilder	createContainerBuilder(RegistryImage baseImage) Starts the containerization process.
List<Path>	getClassFiles()
Path	getDefaultCacheDirectory()
EventHandlers	getEventHandlers()
String	getJarPluginName()
String	getMainClassFromJar()
int	getMajorJavaVersion()
String	getName()
String	getPluginName()
static String	getProperty(String propertyName, org.apache.maven.project.MavenProject project, org.apache.maven.execution.MavenSession session) Gets a system property with the given name.
String	getToolName()
String	getVersion()
boolean	isWarProject()
void	waitForLoggingThread()

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_NAME

public static final String PLUGIN_NAME

Used for logging during main class inference and analysis of user configuration.

See Also:

Constant Field Values

PLUGIN_KEY

public static final String PLUGIN_KEY

Used to identify this plugin when interacting with the maven system.

See Also:

Constant Field Values

Method Detail

getProperty

@Nullable
public static String getProperty(String propertyName,
                                           @Nullable
                                           org.apache.maven.project.MavenProject project,
                                           @Nullable
                                           org.apache.maven.execution.MavenSession session)

Gets a system property with the given name. First checks for a -D commandline argument, then checks for a property defined in the POM, then returns null if neither are defined.

Parameters:

propertyName - the name of the system property

Returns:

the value of the system property, or null if not defined

createContainerBuilder

public JibContainerBuilder createContainerBuilder(RegistryImage baseImage)
                                           throws IOException

Description copied from interface: ProjectProperties

Starts the containerization process.

Specified by:

createContainerBuilder in interface ProjectProperties

Parameters:

baseImage - the base image

Returns:

a JibContainerBuilder with classes, resources, and dependencies added to it

Throws:

IOException - if there is a problem walking the project files

getClassFiles

public List<Path> getClassFiles()
                         throws IOException

Specified by:

getClassFiles in interface ProjectProperties

Throws:

IOException

waitForLoggingThread

public void waitForLoggingThread()

Specified by:

waitForLoggingThread in interface ProjectProperties

getEventHandlers

public EventHandlers getEventHandlers()

Specified by:

getEventHandlers in interface ProjectProperties

getToolName

public String getToolName()

Specified by:

getToolName in interface ProjectProperties

getPluginName

public String getPluginName()

Specified by:

getPluginName in interface ProjectProperties

getMainClassFromJar

@Nullable
public String getMainClassFromJar()

Specified by:

getMainClassFromJar in interface ProjectProperties

Returns:

the name of the main class configured in a jar plugin, or null if none is found.

getDefaultCacheDirectory

public Path getDefaultCacheDirectory()

Specified by:

getDefaultCacheDirectory in interface ProjectProperties

getJarPluginName

public String getJarPluginName()

Specified by:

getJarPluginName in interface ProjectProperties

isWarProject

public boolean isWarProject()

Specified by:

isWarProject in interface ProjectProperties

getName

public String getName()

Specified by:

getName in interface ProjectProperties

getVersion

public String getVersion()

Specified by:

getVersion in interface ProjectProperties

getMajorJavaVersion

public int getMajorJavaVersion()

Specified by:

getMajorJavaVersion in interface ProjectProperties