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

Class HelpfulSuggestions

java.lang.Object

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

public class HelpfulSuggestions
extends Object

Builds messages that provides suggestions on how to fix the error.

Constructor Summary

Constructors

Constructor and Description

HelpfulSuggestions(String messagePrefix, String clearCacheCommand, ImageReference baseImageReference, boolean noCredentialsDefinedForBaseImage, String baseImageCredHelperConfiguration, Function<String,String> baseImageAuthConfiguration, ImageReference targetImageReference, boolean noCredentialsDefinedForTargetImage, String targetImageCredHelperConfiguration, Function<String,String> targetImageAuthConfiguration, String toImageConfiguration, String toImageFlag, String buildConfigurationFilename) Creates a new HelpfulSuggestions with frontend-specific texts.

Method Summary

Modifier and Type	Method and Description
String	forCacheDirectoryNotOwned(Path cacheDirectory)
String	forCacheNeedsClean()
String	forCredentialsNotSent()
static String	forDockerNotInstalled(String messagePrefix)
String	forGeneratedTag(String projectName, String projectVersion)
String	forHttpHostConnect()
String	forHttpStatusCodeForbidden(String imageReference)
static String	forIncompatibleBaseImageJavaVesionForGradle(int baseImageMajorJavaVersion, int projectMajorJavaVersion)
static String	forIncompatibleBaseImageJavaVesionForMaven(int baseImageMajorJavaVersion, int projectMajorJavaVersion)
String	forInsecureRegistry()
static String	forInvalidImageReference(String reference)
static String	forMainClassNotFound(String messagePrefix, String pluginName)
String	forNoCredentialsDefined(String registry, String repository)
static String	forToNotConfigured(String messagePrefix, String parameter, String buildConfigFilename, String command)
String	forUnknownHost()
String	none()
String	suggest(String suggestion)
static String	suggest(String messagePrefix, String suggestion)

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpfulSuggestions

public HelpfulSuggestions(String messagePrefix,
                          String clearCacheCommand,
                          @Nullable
                          ImageReference baseImageReference,
                          boolean noCredentialsDefinedForBaseImage,
                          String baseImageCredHelperConfiguration,
                          Function<String,String> baseImageAuthConfiguration,
                          @Nullable
                          ImageReference targetImageReference,
                          boolean noCredentialsDefinedForTargetImage,
                          String targetImageCredHelperConfiguration,
                          Function<String,String> targetImageAuthConfiguration,
                          String toImageConfiguration,
                          String toImageFlag,
                          String buildConfigurationFilename)

Creates a new HelpfulSuggestions with frontend-specific texts.

Parameters:

messagePrefix - the initial message text

clearCacheCommand - the command for clearing the cache

baseImageReference - the base image reference

noCredentialsDefinedForBaseImage - true if no credentials were defined for the base image; false otherwise

baseImageCredHelperConfiguration - the configuration defining the credential helper name for the base image

baseImageAuthConfiguration - the way to define raw credentials for the base image - takes the base image registry as an argument

targetImageReference - the target image reference

noCredentialsDefinedForTargetImage - true if no credentials were defined for the base image; false otherwise

targetImageCredHelperConfiguration - the configuration defining the credential helper name for the target image

targetImageAuthConfiguration - the way to define raw credentials for the target image - takes the target image registry as an argument

toImageConfiguration - the configuration defining the target image

toImageFlag - the commandline flag used to set the target image

buildConfigurationFilename - the filename of the build configuration

Method Detail

forToNotConfigured

public static String forToNotConfigured(String messagePrefix,
                                        String parameter,
                                        String buildConfigFilename,
                                        String command)

Parameters:

messagePrefix - the initial message text

parameter - the parameter name (e.g. 'to.image' or <to><image>)

buildConfigFilename - the name of the build config (build.gradle or pom.xml)

command - an example command for passing the parameter via commandline

Returns:

a suggested fix for a missing target image configuration

forDockerNotInstalled

public static String forDockerNotInstalled(String messagePrefix)

forMainClassNotFound

public static String forMainClassNotFound(String messagePrefix,
                                          String pluginName)

forIncompatibleBaseImageJavaVesionForGradle

public static String forIncompatibleBaseImageJavaVesionForGradle(int baseImageMajorJavaVersion,
                                                                 int projectMajorJavaVersion)

forIncompatibleBaseImageJavaVesionForMaven

public static String forIncompatibleBaseImageJavaVesionForMaven(int baseImageMajorJavaVersion,
                                                                int projectMajorJavaVersion)

forInvalidImageReference

public static String forInvalidImageReference(String reference)

suggest

public static String suggest(String messagePrefix,
                             String suggestion)

Parameters:

messagePrefix - the initial message text

suggestion - a suggested fix for the problem described by messagePrefix

Returns:

the message containing the suggestion

forHttpHostConnect

public String forHttpHostConnect()

forUnknownHost

public String forUnknownHost()

forCacheNeedsClean

public String forCacheNeedsClean()

forCacheDirectoryNotOwned

public String forCacheDirectoryNotOwned(Path cacheDirectory)

forHttpStatusCodeForbidden

public String forHttpStatusCodeForbidden(String imageReference)

forNoCredentialsDefined

public String forNoCredentialsDefined(String registry,
                                      String repository)

forCredentialsNotSent

public String forCredentialsNotSent()

forInsecureRegistry

public String forInsecureRegistry()

forGeneratedTag

public String forGeneratedTag(String projectName,
                              String projectVersion)

none

public String none()

suggest

public String suggest(String suggestion)

Parameters:

suggestion - a suggested fix for the problem described by messagePrefix

Returns:

the message containing the suggestion