com.google.cloud.tools.jib.frontend

Class HelpfulSuggestions

java.lang.Object

com.google.cloud.tools.jib.frontend.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, String baseImageCredHelperConfiguration, Function<String,String> baseImageAuthConfiguration, String targetImageCredHelperConfiguration, Function<String,String> targetImageAuthConfiguration) Creates a new HelpfulSuggestions with frontend-specific texts.

Method Summary

Modifier and Type	Method and Description
String	forCacheDirectoryNotOwned(Path cacheDirectory)
String	forCacheNeedsClean()
String	forCredentialsNotCorrect(String registry)
String	forDockerContextInsecureRecursiveDelete(String directory)
String	forDockerNotInstalled()
String	forHttpHostConnect()
String	forHttpStatusCodeForbidden(String imageReference)
String	forInsecureRegistry()
String	forMainClassNotFound(String pluginName)
String	forNoCredentialHelpersDefinedForBaseImage(String registry)
String	forNoCredentialHelpersDefinedForTargetImage(String registry)
String	forToNotConfigured(String parameter, String buildConfigFilename, String command)
String	forUnknownHost()
String	none()
String	suggest(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,
                          String baseImageCredHelperConfiguration,
                          Function<String,String> baseImageAuthConfiguration,
                          String targetImageCredHelperConfiguration,
                          Function<String,String> targetImageAuthConfiguration)

Creates a new HelpfulSuggestions with frontend-specific texts.

Parameters:

messagePrefix - the initial message text

clearCacheCommand - the command for clearing the cache

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

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

Method Detail

forHttpHostConnect

public String forHttpHostConnect()

forUnknownHost

public String forUnknownHost()

forCacheNeedsClean

public String forCacheNeedsClean()

forCacheDirectoryNotOwned

public String forCacheDirectoryNotOwned(Path cacheDirectory)

forHttpStatusCodeForbidden

public String forHttpStatusCodeForbidden(String imageReference)

forNoCredentialHelpersDefinedForBaseImage

public String forNoCredentialHelpersDefinedForBaseImage(String registry)

forNoCredentialHelpersDefinedForTargetImage

public String forNoCredentialHelpersDefinedForTargetImage(String registry)

forCredentialsNotCorrect

public String forCredentialsNotCorrect(String registry)

forDockerContextInsecureRecursiveDelete

public String forDockerContextInsecureRecursiveDelete(String directory)

forMainClassNotFound

public String forMainClassNotFound(String pluginName)

forDockerNotInstalled

public String forDockerNotInstalled()

forToNotConfigured

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

Parameters:

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

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

forInsecureRegistry

public String forInsecureRegistry()