EnvUtil (docker-maven-plugin 0.26.1 API)

java.lang.Object
- io.fabric8.maven.docker.util.EnvUtil

```
public class EnvUtil
extends Object
```
Utility class for various (loosely related) environment related tasks.

Since:

04.04.14

Author:

roland

Field Summary

Fields
Modifier and Type Field and Description

static String DOCKER_HTTPS_PORT

static String MAVEN_PROPERTY_REGEXP

static String PROPERTY_COMBINE_POLICY_SUFFIX

Fields
Modifier and Type	Field and Description
`static String`	`DOCKER_HTTPS_PORT`
`static String`	`MAVEN_PROPERTY_REGEXP`
`static String`	`PROPERTY_COMBINE_POLICY_SUFFIX`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`convertTcpToHttpUrl(String connect)`
`static String`	`ensureRegistryHttpUrl(String registry)`
`static List<String>`	`extractFromPropertiesAsList(String prefix, Properties properties)` Extract from given properties a list of string values.
`static Map<String,String>`	`extractFromPropertiesAsMap(String prefix, Properties properties)` Extract part of given properties as a map.
`static String`	`extractLargerVersion(String versionA, String versionB)` Compare to version strings and return the larger version strings.
`static String`	`extractMavenPropertyName(String propName)` Extract from a Maven property which is in the form ${name} the name.
`static String`	`fistRegistryOf(String... checkFirst)` Return the first non null registry given.
`static String`	`fixupPath(String path)` Fix path on Windows machines, i.e.
`static String`	`formatDurationTill(long start)` Calculate the duration between now and the given time Taken mostly from http://stackoverflow.com/a/5062810/207604 .
`static Properties`	`getPropertiesWithSystemOverrides(org.apache.maven.project.MavenProject project)` Return all properties in Maven project, merged with all System properties (-D flags sent to Maven).
`static boolean`	`greaterOrEqualsVersion(String versionA, String versionB)` Check whether the first given API version is larger or equals the second given version
`static boolean`	`isValidWindowsFileName(String filename)` Validate that the provided filename is a valid Windows filename.
`static boolean`	`isWindows()`
`static Date`	`loadTimestamp(File tsFile)`
`static File`	`prepareAbsoluteOutputDirPath(MojoParameters params, String dir, String path)`
`static File`	`prepareAbsoluteSourceDirPath(MojoParameters params, String path)`
`static List<String>`	`removeEmptyEntries(List<String> input)` Remove empty members of a list.
`static List<String>`	`splitAtCommasAndTrim(Iterable<String> input)` Split each element of an Iterable at commas.
`static List<String[]>`	`splitOnLastColon(List<String> listToSplit)` Splits every element in the given list on the last colon in the name and returns a list with two elements: The left part before the colon and the right part after the colon.
`static String[]`	`splitOnSpaceWithEscape(String toSplit)`
`static void`	`storeTimestamp(File tsFile, Date buildDate)`
`static String`	`stringJoin(List list, String separator)` Join a list of objects to a string with a given separator by calling Object.toString() on the elements.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAVEN_PROPERTY_REGEXP
```
public static final String MAVEN_PROPERTY_REGEXP
```
    See Also:
    
    Constant Field Values
  - DOCKER_HTTPS_PORT
```
public static final String DOCKER_HTTPS_PORT
```
    See Also:
    
    Constant Field Values
  - PROPERTY_COMBINE_POLICY_SUFFIX
```
public static final String PROPERTY_COMBINE_POLICY_SUFFIX
```
    See Also:
    
    Constant Field Values
- Method Detail
  - convertTcpToHttpUrl
```
public static String convertTcpToHttpUrl(String connect)
```
  - extractLargerVersion
```
public static String extractLargerVersion(String versionA,
                                          String versionB)
```
    Compare to version strings and return the larger version strings. This is used in calculating the minimal required API version for this plugin. Version strings must be comparable as floating numbers. The versions must be given in the format in a semantic version foramt (e.g. "1.23" If either version is null, the other version is returned (which can be null as well)
    
    Parameters:
    
    versionA - first version number
    
    versionB - second version number
    
    Returns:
    
    the larger version number
  - greaterOrEqualsVersion
```
public static boolean greaterOrEqualsVersion(String versionA,
                                             String versionB)
```
    Check whether the first given API version is larger or equals the second given version
    
    Parameters:
    
    versionA - first version to check against
    
    versionB - the second version
    
    Returns:
    
    true if versionA is greater or equals versionB, false otherwise
  - splitOnLastColon
```
public static List<String[]> splitOnLastColon(List<String> listToSplit)
```
    Splits every element in the given list on the last colon in the name and returns a list with two elements: The left part before the colon and the right part after the colon. If the string doesn't contain a colon, the value is used for both elements in the returned arrays.
    
    Parameters:
    
    listToSplit - list of strings to split
    
    Returns:
    
    return list of 2-element arrays or an empty list if the given list is empty or null
  - removeEmptyEntries
```
@Nonnull
public static List<String> removeEmptyEntries(@Nullable
                                                       List<String> input)
```
    Remove empty members of a list.
    
    Parameters:
    
    input - A list of String
    
    Returns:
    
    A list of Non-Empty (length>0) String
  - splitAtCommasAndTrim
```
@Nonnull
public static List<String> splitAtCommasAndTrim(Iterable<String> input)
```
    Split each element of an Iterable at commas.
    
    Parameters:
    
    input - Iterable over strings.
    
    Returns:
    
    An Iterable over string which breaks down each input element at comma boundaries
  - splitOnSpaceWithEscape
```
public static String[] splitOnSpaceWithEscape(String toSplit)
```
  - stringJoin
```
public static String stringJoin(List list,
                                String separator)
```
    Join a list of objects to a string with a given separator by calling Object.toString() on the elements.
    
    Parameters:
    
    list - to join
    
    separator - separator to use
    
    Returns:
    
    the joined string.
  - getPropertiesWithSystemOverrides
```
public static Properties getPropertiesWithSystemOverrides(org.apache.maven.project.MavenProject project)
```
    Return all properties in Maven project, merged with all System properties (-D flags sent to Maven). System properties always takes precedence.
    
    Parameters:
    
    project - Project to extract Properties from
    
    Returns:
  - extractFromPropertiesAsMap
```
public static Map<String,String> extractFromPropertiesAsMap(String prefix,
                                                            Properties properties)
```
    Extract part of given properties as a map. The given prefix is used to find the properties, the rest of the property name is used as key for the map. NOTE: If key is "._combine" (#PROPERTY_COMBINE_POLICY_SUFFIX) it is ignored! This is reserved for combine policy tweaking.
    
    Parameters:
    
    prefix - prefix which specifies the part which should be extracted as map
    
    properties - properties to extract from
    
    Returns:
    
    the extracted map or null if no such map exists
  - extractFromPropertiesAsList
```
public static List<String> extractFromPropertiesAsList(String prefix,
                                                       Properties properties)
```
    Extract from given properties a list of string values. The prefix is used to determine the subset of the given properties from which the list should be extracted, the rest is used as a numeric index. If the rest is not numeric, the order is not determined (all those props are appended to the end of the list) NOTE: If suffix/index is "._combine" (#PROPERTY_COMBINE_POLICY_SUFFIX) it is ignored! This is reserved for combine policy tweaking.
    
    Parameters:
    
    prefix - for selecting the properties from which the list should be extracted
    
    properties - properties from which to extract from
    
    Returns:
    
    parsed list or null if no element with prefixes exists
  - extractMavenPropertyName
```
public static String extractMavenPropertyName(String propName)
```
    Extract from a Maven property which is in the form ${name} the name.
    
    Parameters:
    
    propName - property name to extrat
    
    Returns:
    
    the pure name or null if this is not a property name
  - fixupPath
```
public static String fixupPath(String path)
```
    Fix path on Windows machines, i.e. convert 'c:\...\' to '/c/..../'
    
    Parameters:
    
    path - path to fix
    
    Returns:
    
    the fixed path
  - formatDurationTill
```
public static String formatDurationTill(long start)
```
    Calculate the duration between now and the given time Taken mostly from http://stackoverflow.com/a/5062810/207604 . Kudos to @dblevins
    
    Parameters:
    
    start - starting time (in milliseconds)
    
    Returns:
    
    time in seconds
  - fistRegistryOf
```
public static String fistRegistryOf(String... checkFirst)
```
    Return the first non null registry given. Use the env var DOCKER_REGISTRY as final fallback
    
    Parameters:
    
    checkFirst - list of registries to check
    
    Returns:
    
    registry found or null if none.
  - ensureRegistryHttpUrl
```
public static String ensureRegistryHttpUrl(String registry)
```
  - prepareAbsoluteOutputDirPath
```
public static File prepareAbsoluteOutputDirPath(MojoParameters params,
                                                String dir,
                                                String path)
```
  - prepareAbsoluteSourceDirPath
```
public static File prepareAbsoluteSourceDirPath(MojoParameters params,
                                                String path)
```
  - storeTimestamp
```
public static void storeTimestamp(File tsFile,
                                  Date buildDate)
                           throws org.apache.maven.plugin.MojoExecutionException
```
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - loadTimestamp
```
public static Date loadTimestamp(File tsFile)
                          throws org.apache.maven.plugin.MojoExecutionException
```
    Throws:
    
    org.apache.maven.plugin.MojoExecutionException
  - isWindows
```
public static boolean isWindows()
```
  - isValidWindowsFileName
```
public static boolean isValidWindowsFileName(String filename)
```
    Validate that the provided filename is a valid Windows filename. The validation of the Windows filename is copied from stackoverflow: https://stackoverflow.com/a/6804755
    
    Parameters:
    
    filename - the filename
    
    Returns:
    
    filename is a valid Windows filename

Class EnvUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAVEN_PROPERTY_REGEXP

DOCKER_HTTPS_PORT

PROPERTY_COMBINE_POLICY_SUFFIX

Method Detail

convertTcpToHttpUrl

extractLargerVersion

greaterOrEqualsVersion

splitOnLastColon

removeEmptyEntries

splitAtCommasAndTrim

splitOnSpaceWithEscape

stringJoin

getPropertiesWithSystemOverrides

extractFromPropertiesAsMap

extractFromPropertiesAsList

extractMavenPropertyName

fixupPath

formatDurationTill

fistRegistryOf

ensureRegistryHttpUrl

prepareAbsoluteOutputDirPath

prepareAbsoluteSourceDirPath

storeTimestamp

loadTimestamp

isWindows

isValidWindowsFileName