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

Class PluginConfigurationProcessor

java.lang.Object

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

public class PluginConfigurationProcessor
extends Object

Configures and provides JibContainerBuilder for the image building tasks based on raw plugin configuration values and project properties.

Method Summary

Modifier and Type	Method and Description
static AbsoluteUnixPath	getAppRootChecked(RawConfiguration rawConfiguration, boolean isWarProject) Gets the value of the appRoot parameter.
ImageReference	getBaseImageReference()
Containerizer	getContainerizer()
JibContainerBuilder	getJibContainerBuilder()
ImageReference	getTargetImageReference()
boolean	isBaseImageCredentialPresent()
boolean	isTargetImageCredentialPresent()
static PluginConfigurationProcessor	processCommonConfigurationForDockerDaemonImage(RawConfiguration rawConfiguration, Function<String,Optional<AuthProperty>> inferredAuthProvider, ProjectProperties projectProperties, Path dockerExecutable, Map<String,String> dockerEnvironment, HelpfulSuggestions helpfulSuggestions)
static PluginConfigurationProcessor	processCommonConfigurationForRegistryImage(RawConfiguration rawConfiguration, Function<String,Optional<AuthProperty>> inferredAuthProvider, ProjectProperties projectProperties)
static PluginConfigurationProcessor	processCommonConfigurationForTarImage(RawConfiguration rawConfiguration, Function<String,Optional<AuthProperty>> inferredAuthProvider, ProjectProperties projectProperties, Path tarImagePath, HelpfulSuggestions helpfulSuggestions)

Methods inherited from class java.lang.Object

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

Method Detail

processCommonConfigurationForDockerDaemonImage

public static PluginConfigurationProcessor processCommonConfigurationForDockerDaemonImage(RawConfiguration rawConfiguration,
                                                                                          Function<String,Optional<AuthProperty>> inferredAuthProvider,
                                                                                          ProjectProperties projectProperties,
                                                                                          @Nullable
                                                                                          Path dockerExecutable,
                                                                                          @Nullable
                                                                                          Map<String,String> dockerEnvironment,
                                                                                          HelpfulSuggestions helpfulSuggestions)
                                                                                   throws InvalidImageReferenceException,
                                                                                          MainClassInferenceException,
                                                                                          InvalidAppRootException,
                                                                                          IOException,
                                                                                          InvalidWorkingDirectoryException,
                                                                                          InvalidContainerVolumeException,
                                                                                          IncompatibleBaseImageJavaVersionException

Throws:

InvalidImageReferenceException

MainClassInferenceException

InvalidAppRootException

IOException

InvalidWorkingDirectoryException

InvalidContainerVolumeException

IncompatibleBaseImageJavaVersionException

processCommonConfigurationForTarImage

public static PluginConfigurationProcessor processCommonConfigurationForTarImage(RawConfiguration rawConfiguration,
                                                                                 Function<String,Optional<AuthProperty>> inferredAuthProvider,
                                                                                 ProjectProperties projectProperties,
                                                                                 Path tarImagePath,
                                                                                 HelpfulSuggestions helpfulSuggestions)
                                                                          throws InvalidImageReferenceException,
                                                                                 MainClassInferenceException,
                                                                                 InvalidAppRootException,
                                                                                 IOException,
                                                                                 InvalidWorkingDirectoryException,
                                                                                 InvalidContainerVolumeException,
                                                                                 IncompatibleBaseImageJavaVersionException

Throws:

InvalidImageReferenceException

MainClassInferenceException

InvalidAppRootException

IOException

InvalidWorkingDirectoryException

InvalidContainerVolumeException

IncompatibleBaseImageJavaVersionException

processCommonConfigurationForRegistryImage

public static PluginConfigurationProcessor processCommonConfigurationForRegistryImage(RawConfiguration rawConfiguration,
                                                                                      Function<String,Optional<AuthProperty>> inferredAuthProvider,
                                                                                      ProjectProperties projectProperties)
                                                                               throws InvalidImageReferenceException,
                                                                                      MainClassInferenceException,
                                                                                      InvalidAppRootException,
                                                                                      IOException,
                                                                                      InvalidWorkingDirectoryException,
                                                                                      InvalidContainerVolumeException,
                                                                                      IncompatibleBaseImageJavaVersionException

Throws:

InvalidImageReferenceException

MainClassInferenceException

InvalidAppRootException

IOException

InvalidWorkingDirectoryException

InvalidContainerVolumeException

IncompatibleBaseImageJavaVersionException

getAppRootChecked

public static AbsoluteUnixPath getAppRootChecked(RawConfiguration rawConfiguration,
                                                 boolean isWarProject)
                                          throws InvalidAppRootException

Gets the value of the appRoot parameter. If the parameter is empty, returns JavaContainerBuilder.DEFAULT_WEB_APP_ROOT for WAR projects or JavaContainerBuilder.DEFAULT_APP_ROOT for other projects.

Parameters:

rawConfiguration - raw configuration data

isWarProject - whether or not the project is a WAR project

Returns:

the app root value

Throws:

InvalidAppRootException - if appRoot value is not an absolute Unix path

getJibContainerBuilder

public JibContainerBuilder getJibContainerBuilder()

getContainerizer

public Containerizer getContainerizer()

getBaseImageReference

public ImageReference getBaseImageReference()

getTargetImageReference

public ImageReference getTargetImageReference()

isBaseImageCredentialPresent

public boolean isBaseImageCredentialPresent()

isTargetImageCredentialPresent

public boolean isTargetImageCredentialPresent()