org.jfrog.build.extractor.clientConfiguration.util.spec

Class UploadSpecHelper

java.lang.Object

org.jfrog.build.extractor.clientConfiguration.util.spec.UploadSpecHelper

public class UploadSpecHelper
extends java.lang.Object

Created by diman on 15/05/2017.

Constructor Summary

Constructors

Constructor and Description
UploadSpecHelper()

Method Summary

Modifier and Type	Method and Description
static DeployDetails	buildDeployDetails(java.lang.String targetPath, java.io.File artifactFile, java.lang.String uploadTarget, java.lang.String explode, java.lang.String props, com.google.common.collect.Multimap<java.lang.String,java.lang.String> buildProperties) Create a DeployDetails from the given properties
static java.lang.String	calculateFileTargetPath(java.io.File patternDir, java.io.File file, java.lang.String targetPath)
static java.lang.String	calculateTargetRelativePath(java.io.File artifactFile)
static java.lang.String	getLocalPath(java.lang.String path) Remove repository's name from a given Spec's target
static java.lang.String	getRegexBaseDir(java.io.File workspaceDir, java.lang.String pattern) Returns base directory path with slash in the end.
static java.lang.String	getRelativePath(java.io.File base, java.io.File file) Gets the relative path of a given file to the base
static java.lang.String	getRelativeToWsPath(java.lang.String absolutePath, java.lang.String workspacePath) Gets the relative path of a given file to the workspace path.
protected static java.lang.String	getUploadPath(java.io.File file, java.util.regex.Pattern pathPattern, java.lang.String targetPath, boolean isFlat, boolean isAbsolutePath, java.io.File workspaceDir, boolean isTargetDirectory)
static com.google.common.collect.Multimap<java.lang.String,java.io.File>	getUploadPathsMap(java.util.List<java.io.File> files, java.io.File workspaceDir, java.lang.String targetPath, boolean isFlat, java.util.regex.Pattern regexPattern, boolean isAbsolutePath)
static java.lang.String	getWildcardBaseDir(java.io.File workspaceDir, java.lang.String pattern) Returns base directory path with slash in the end.
static java.lang.String	prepareExcludePattern(java.lang.String[] excludePatterns, boolean isWildcard, boolean recursive)
static java.lang.String	prepareRegexPattern(java.io.File workspaceDir, java.lang.String pattern, java.lang.String baseDir) The user can provide pattern that will contain static path (without wildcards) that will become part of the base directory.
static java.lang.String	prepareWildcardPattern(java.io.File workspaceDir, java.lang.String pattern, java.lang.String baseDir) The user can provide pattern that will contain static path (without wildcards) that will become part of the base directory.
static java.lang.String	wildcardCalculateTargetPath(java.lang.String targetPattern, java.io.File artifactFile) Calculates the target deployment path of an artifact by it's name

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadSpecHelper

public UploadSpecHelper()

Method Detail

buildDeployDetails

public static DeployDetails buildDeployDetails(java.lang.String targetPath,
                                               java.io.File artifactFile,
                                               java.lang.String uploadTarget,
                                               java.lang.String explode,
                                               java.lang.String props,
                                               com.google.common.collect.Multimap<java.lang.String,java.lang.String> buildProperties)
                                        throws java.io.IOException,
                                               java.security.NoSuchAlgorithmException

Create a DeployDetails from the given properties

Parameters:

targetPath - target of the created artifact in Artifactory

artifactFile - the artifact to deploy

uploadTarget - target repository in Artifactory

explode - explode archive

props - properties to attach to the deployed file

buildProperties - a map of properties to add to the DeployDetails objects

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

wildcardCalculateTargetPath

public static java.lang.String wildcardCalculateTargetPath(java.lang.String targetPattern,
                                                           java.io.File artifactFile)

Calculates the target deployment path of an artifact by it's name

Parameters:

targetPattern - a wildcard pattern of the target path

artifactFile - the artifact file to calculate target deployment path for

Returns:

the calculated target path (supports file renaming).

calculateTargetRelativePath

public static java.lang.String calculateTargetRelativePath(java.io.File artifactFile)

getRelativeToWsPath

public static java.lang.String getRelativeToWsPath(java.lang.String absolutePath,
                                                   java.lang.String workspacePath)

Gets the relative path of a given file to the workspace path.

Parameters:

absolutePath - the file's absolute path

workspacePath - path to the job's workspace

Returns:

the relative path of a given file to the workspace path

prepareExcludePattern

public static java.lang.String prepareExcludePattern(java.lang.String[] excludePatterns,
                                                     boolean isWildcard,
                                                     boolean recursive)

getUploadPath

protected static java.lang.String getUploadPath(java.io.File file,
                                                java.util.regex.Pattern pathPattern,
                                                java.lang.String targetPath,
                                                boolean isFlat,
                                                boolean isAbsolutePath,
                                                java.io.File workspaceDir,
                                                boolean isTargetDirectory)

getUploadPathsMap

public static com.google.common.collect.Multimap<java.lang.String,java.io.File> getUploadPathsMap(java.util.List<java.io.File> files,
                                                                                                  java.io.File workspaceDir,
                                                                                                  java.lang.String targetPath,
                                                                                                  boolean isFlat,
                                                                                                  java.util.regex.Pattern regexPattern,
                                                                                                  boolean isAbsolutePath)

getWildcardBaseDir

public static java.lang.String getWildcardBaseDir(java.io.File workspaceDir,
                                                  java.lang.String pattern)

Returns base directory path with slash in the end. The base directory is the path where the file collection starts from. Base directory is the last directory that not contains wildcards in case of regexp=false. In case of regexp=true the base directory will be the last existing directory that not contains a regex char.

Parameters:

workspaceDir - the workspaceDir directory

pattern - the pattern provided by the user

Returns:

String that represents the base directory

getRegexBaseDir

public static java.lang.String getRegexBaseDir(java.io.File workspaceDir,
                                               java.lang.String pattern)
                                        throws java.io.FileNotFoundException

Returns base directory path with slash in the end. The base directory is the path where the file collection starts from. Base directory is the last directory that not contains wildcards in case of regexp=false. In case of regexp=true the base directory will be the last existing directory that not contains a regex char.

Parameters:

workspaceDir - the workspaceDir directory

pattern - the pattern provided by the user

Returns:

String that represents the base directory

Throws:

java.io.FileNotFoundException

prepareRegexPattern

public static java.lang.String prepareRegexPattern(java.io.File workspaceDir,
                                                   java.lang.String pattern,
                                                   java.lang.String baseDir)

The user can provide pattern that will contain static path (without wildcards) that will become part of the base directory. this method removes the part of the pattern that exists in the base directory.

Parameters:

workspaceDir - the workspaceDir directory

pattern - the provided by the user pattern

baseDir - the calculated base directory

Returns:

new calculated pattern based on the provided patern and base directory

prepareWildcardPattern

public static java.lang.String prepareWildcardPattern(java.io.File workspaceDir,
                                                      java.lang.String pattern,
                                                      java.lang.String baseDir)

The user can provide pattern that will contain static path (without wildcards) that will become part of the base directory. this method removes the part of the pattern that exists in the base directory.

Parameters:

workspaceDir - the workspaceDir directory

pattern - the provided by the user pattern

baseDir - the calculated base directory

Returns:

new calculated pattern based on the provided patern and base directory

getRelativePath

public static java.lang.String getRelativePath(java.io.File base,
                                               java.io.File file)

Gets the relative path of a given file to the base

Parameters:

base - the base path to calculate the relative path

file - the file itself

Returns:

the calculated relative path

calculateFileTargetPath

public static java.lang.String calculateFileTargetPath(java.io.File patternDir,
                                                       java.io.File file,
                                                       java.lang.String targetPath)

getLocalPath

public static java.lang.String getLocalPath(java.lang.String path)

Remove repository's name from a given Spec's target

Parameters:

path - target path in Artifactory

Returns:

the local path inside the repository