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 List<String>	computeEntrypoint(RawConfiguration rawConfiguration, ProjectProperties projectProperties) Compute the container entrypoint, in this order: null (inheriting from the base image), if the user specified value is INHERIT the user specified one, if set for a WAR project, null (it must be inherited from base image) for a non-WAR project, by resolving the main class
static String	getBaseImage(RawConfiguration rawConfiguration, ProjectProperties projectProperties) Gets the suitable value for the base image.
ImageReference	getBaseImageReference()
Containerizer	getContainerizer()
JibContainerBuilder	getJibContainerBuilder()
ImageReference	getTargetImageReference()
boolean	isBaseImageCredentialPresent()
boolean	isTargetImageCredentialPresent()
static PluginConfigurationProcessor	processCommonConfigurationForDockerDaemonImage(RawConfiguration rawConfiguration, ProjectProperties projectProperties, Path dockerExecutable, Map<String,String> dockerEnvironment, HelpfulSuggestions helpfulSuggestions)
static PluginConfigurationProcessor	processCommonConfigurationForRegistryImage(RawConfiguration rawConfiguration, ProjectProperties projectProperties)
static PluginConfigurationProcessor	processCommonConfigurationForTarImage(RawConfiguration rawConfiguration, 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

computeEntrypoint

@Nullable
public static List<String> computeEntrypoint(RawConfiguration rawConfiguration,
                                                       ProjectProperties projectProperties)
                                                throws MainClassInferenceException,
                                                       InvalidAppRootException

Compute the container entrypoint, in this order:

1. null (inheriting from the base image), if the user specified value is INHERIT
2. the user specified one, if set
3. for a WAR project, null (it must be inherited from base image)
4. for a non-WAR project, by resolving the main class

Parameters:

rawConfiguration - raw configuration data

projectProperties - used for providing additional information

Returns:

the entrypoint

Throws:

MainClassInferenceException - if no valid main class is configured or discovered

InvalidAppRootException - if appRoot value is not an absolute Unix path

getBaseImage

public static String getBaseImage(RawConfiguration rawConfiguration,
                                  ProjectProperties projectProperties)

Gets the suitable value for the base image. If the raw base image parameter is null, returns "gcr.io/distroless/java/jetty" for WAR projects or "gcr.io/distroless/java" for non-WAR.

Parameters:

rawConfiguration - raw configuration data

projectProperties - used for providing additional information

Returns:

the base image

processCommonConfigurationForDockerDaemonImage

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

Throws:

InvalidImageReferenceException

MainClassInferenceException

InvalidAppRootException

InferredAuthRetrievalException

IOException

InvalidWorkingDirectoryException

InvalidContainerVolumeException

processCommonConfigurationForTarImage

public static PluginConfigurationProcessor processCommonConfigurationForTarImage(RawConfiguration rawConfiguration,
                                                                                 ProjectProperties projectProperties,
                                                                                 Path tarImagePath,
                                                                                 HelpfulSuggestions helpfulSuggestions)
                                                                          throws InvalidImageReferenceException,
                                                                                 MainClassInferenceException,
                                                                                 InvalidAppRootException,
                                                                                 InferredAuthRetrievalException,
                                                                                 IOException,
                                                                                 InvalidWorkingDirectoryException,
                                                                                 InvalidContainerVolumeException

Throws:

InvalidImageReferenceException

MainClassInferenceException

InvalidAppRootException

InferredAuthRetrievalException

IOException

InvalidWorkingDirectoryException

InvalidContainerVolumeException

processCommonConfigurationForRegistryImage

public static PluginConfigurationProcessor processCommonConfigurationForRegistryImage(RawConfiguration rawConfiguration,
                                                                                      ProjectProperties projectProperties)
                                                                               throws InferredAuthRetrievalException,
                                                                                      InvalidImageReferenceException,
                                                                                      MainClassInferenceException,
                                                                                      InvalidAppRootException,
                                                                                      IOException,
                                                                                      InvalidWorkingDirectoryException,
                                                                                      InvalidContainerVolumeException

Throws:

InferredAuthRetrievalException

InvalidImageReferenceException

MainClassInferenceException

InvalidAppRootException

IOException

InvalidWorkingDirectoryException

InvalidContainerVolumeException

getJibContainerBuilder

public JibContainerBuilder getJibContainerBuilder()

getContainerizer

public Containerizer getContainerizer()

getBaseImageReference

public ImageReference getBaseImageReference()

getTargetImageReference

public ImageReference getTargetImageReference()

isBaseImageCredentialPresent

public boolean isBaseImageCredentialPresent()

isTargetImageCredentialPresent

public boolean isTargetImageCredentialPresent()