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 ImageReference	getGeneratedTargetDockerTag(String targetImage, ProjectProperties projectProperties, 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 Optional<Credential>	getImageCredential(Consumer<LogEvent> logger, String usernameProperty, String passwordProperty, AuthProperty auth, RawConfiguration rawConfiguration) Gets a Credential from a username and password.
static List<String>	parseListProperty(String property) Parses a comma-separated string into a list.
static Map<String,String>	parseMapProperty(String property) Parses a string in the form of "key1=value1,key2=value2,..." into a map.

Methods inherited from class java.lang.Object

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

Method Detail

getImageCredential

public static Optional<Credential> getImageCredential(Consumer<LogEvent> logger,
                                                      String usernameProperty,
                                                      String passwordProperty,
                                                      AuthProperty auth,
                                                      RawConfiguration rawConfiguration)

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

Parameters:

logger - a consumer for handling log events

usernameProperty - the name of the username system property

passwordProperty - the name of the password system property

auth - the configured credentials

rawConfiguration - the RawConfiguration that provides system properties

Returns:

a new Authorization from the system properties or build configuration, or Optional.empty() if neither is configured.

getGeneratedTargetDockerTag

public static ImageReference getGeneratedTargetDockerTag(@Nullable
                                                         String targetImage,
                                                         ProjectProperties projectProperties,
                                                         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

projectProperties - the ProjectProperties providing the project name, version, and log event handler

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

parseMapProperty

public static Map<String,String> parseMapProperty(String property)

Parses a string in the form of "key1=value1,key2=value2,..." into a map.

Parameters:

property - the map string to parse, with entries separated by "," and key-value pairs separated by "="

Returns:

the map of parsed values

parseListProperty

public static List<String> parseListProperty(String property)

Parses a comma-separated string into a list. Ignores commas escaped with "\".

Parameters:

property - the comma-separated string

Returns:

the list of parsed values