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

Class ConfigurationPropertyValidator

java.lang.Object

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

public class ConfigurationPropertyValidator
extends Object

Validator for plugin configuration parameters and system properties.

Method Summary

Modifier and Type	Method and Description
static <T extends Throwable> void	checkHttpTimeoutProperty(Function<String,T> exceptionFactory) Checks the jib.httpTimeout system property for invalid (non-integer or negative) values.
static ImageReference	getGeneratedTargetDockerTag(String targetImage, JibLogger logger, String projectName, String projectVersion, HelpfulSuggestions helpfulSuggestions) Returns an ImageReference parsed from the configured target image, or one of the form project-name:project-version if target image is not configured
static Credential	getImageCredential(JibLogger logger, String usernameProperty, String passwordProperty, AuthProperty auth) Gets a Credential from a username and password.

Methods inherited from class java.lang.Object

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

Method Detail

checkHttpTimeoutProperty

public static <T extends Throwable> void checkHttpTimeoutProperty(Function<String,T> exceptionFactory)
                                                           throws T extends Throwable

Checks the jib.httpTimeout system property for invalid (non-integer or negative) values.

Type Parameters:

T - the exception type to throw if invalid values

Parameters:

exceptionFactory - factory to create an exception with the given description

Throws:

T - if invalid values

T extends Throwable

getImageCredential

@Nullable
public static Credential getImageCredential(JibLogger logger,
                                                      String usernameProperty,
                                                      String passwordProperty,
                                                      AuthProperty auth)

Gets a Credential from a username and password. First tries system properties, then tries build configuration, otherwise returns null.

Parameters:

logger - the JibLogger used to print warnings messages

usernameProperty - the name of the username system property

passwordProperty - the name of the password system property

auth - the configured credentials

Returns:

a new Authorization from the system properties or build configuration, or null if neither is configured.

getGeneratedTargetDockerTag

public static ImageReference getGeneratedTargetDockerTag(@Nullable
                                                         String targetImage,
                                                         JibLogger logger,
                                                         String projectName,
                                                         String projectVersion,
                                                         HelpfulSuggestions helpfulSuggestions)
                                                  throws InvalidImageReferenceException

Returns an ImageReference parsed from the configured target image, or one of the form project-name:project-version if target image is not configured

Parameters:

targetImage - the configured target image reference

logger - the JibLogger used to show messages

projectName - the project name, as determined by the plugin

projectVersion - the project version, as determined by the plugin

helpfulSuggestions - used for generating the message notifying the user of the generated tag

Returns:

an ImageReference parsed from the configured target image, or one of the form project-name:project-version if target image is not configured

Throws:

InvalidImageReferenceException - if the configured or generated image reference is invalid