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

Class HelpfulSuggestions

java.lang.Object

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

public class HelpfulSuggestions
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description

HelpfulSuggestions(java.lang.String messagePrefix, java.lang.String clearCacheCommand, java.lang.String baseImageCredHelperConfiguration, java.util.function.Function<java.lang.String,java.lang.String> baseImageAuthConfiguration, java.lang.String targetImageCredHelperConfiguration, java.util.function.Function<java.lang.String,java.lang.String> targetImageAuthConfiguration) Creates a new HelpfulSuggestions with frontend-specific texts.

Method Summary

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

forUnknownHost

public java.lang.String forUnknownHost()

forCacheNeedsClean

public java.lang.String forCacheNeedsClean()

forCacheDirectoryNotOwned

public java.lang.String forCacheDirectoryNotOwned(java.nio.file.Path cacheDirectory)

forHttpStatusCodeForbidden

public java.lang.String forHttpStatusCodeForbidden(java.lang.String imageReference)

forNoCredentialHelpersDefinedForBaseImage

public java.lang.String forNoCredentialHelpersDefinedForBaseImage(java.lang.String registry)

forNoCredentialHelpersDefinedForTargetImage

public java.lang.String forNoCredentialHelpersDefinedForTargetImage(java.lang.String registry)

forCredentialsNotCorrect

public java.lang.String forCredentialsNotCorrect(java.lang.String registry)

forCredentialsNotSent

public java.lang.String forCredentialsNotSent()

forDockerContextInsecureRecursiveDelete

public java.lang.String forDockerContextInsecureRecursiveDelete(java.lang.String directory)

forMainClassNotFound

public java.lang.String forMainClassNotFound(java.lang.String pluginName)

forDockerNotInstalled

public java.lang.String forDockerNotInstalled()

forInsecureRegistry

public java.lang.String forInsecureRegistry()

forToNotConfigured

public java.lang.String forToNotConfigured(java.lang.String parameter,
                                           java.lang.String buildConfigFilename,
                                           java.lang.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 java.lang.String none()

suggest

public java.lang.String suggest(java.lang.String suggestion)

Parameters:

suggestion - a suggested fix for the problem described by messagePrefix

Returns:

the message containing the suggestion