com.google.cloud.tools.jib.plugins.common

Interface ProjectProperties

All Known Implementing Classes:

MavenProjectProperties

public interface ProjectProperties

Project property methods that require maven/gradle-specific implementations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_DIRECTORY_NAME Directory name for the cache.
static String	EXPLODED_WAR_DIRECTORY_NAME Directory name for the exploded WAR.

Method Summary

Modifier and Type	Method and Description
void	configureEventHandlers(Containerizer containerizer) Adds the plugin's event handlers to a containerizer.
JibContainerBuilder	createJibContainerBuilder(JavaContainerBuilder javaContainerBuilder, ContainerizingMode containerizingMode) Starts the containerization process.
List<Path>	getClassFiles()
Path	getDefaultCacheDirectory()
String	getJarPluginName()
String	getMainClassFromJar()
int	getMajorJavaVersion()
String	getName()
Path	getOutputDirectory()
String	getPluginName()
String	getToolName()
String	getVersion()
boolean	isOffline()
boolean	isWarProject()
void	log(LogEvent logEvent)
void	waitForLoggingThread()

Field Detail

CACHE_DIRECTORY_NAME

static final String CACHE_DIRECTORY_NAME

Directory name for the cache. The directory will be relative to the build output directory.

See Also:

Constant Field Values

EXPLODED_WAR_DIRECTORY_NAME

static final String EXPLODED_WAR_DIRECTORY_NAME

Directory name for the exploded WAR. The directory will be relative to the build output directory.

See Also:

Constant Field Values

Method Detail

waitForLoggingThread

void waitForLoggingThread()

configureEventHandlers

void configureEventHandlers(Containerizer containerizer)

Adds the plugin's event handlers to a containerizer.

Parameters:

containerizer - the containerizer to add event handlers to

log

void log(LogEvent logEvent)

getToolName

String getToolName()

getPluginName

String getPluginName()

createJibContainerBuilder

JibContainerBuilder createJibContainerBuilder(JavaContainerBuilder javaContainerBuilder,
                                              ContainerizingMode containerizingMode)
                                       throws IOException

Starts the containerization process.

Parameters:

javaContainerBuilder - Java container builder to start with

containerizingMode - mode to containerize the app

Returns:

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

Throws:

IOException - if there is a problem walking the project files

getClassFiles

List<Path> getClassFiles()
                  throws IOException

Throws:

IOException

getDefaultCacheDirectory

Path getDefaultCacheDirectory()

getJarPluginName

String getJarPluginName()

getMainClassFromJar

@Nullable
String getMainClassFromJar()

Returns:

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

isWarProject

boolean isWarProject()

getName

String getName()

getVersion

String getVersion()

getOutputDirectory

Path getOutputDirectory()

getMajorJavaVersion

int getMajorJavaVersion()

isOffline

boolean isOffline()