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

Class SpecsHelper

java.lang.Object

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

public class SpecsHelper
extends java.lang.Object

Created by diman on 24/08/2016.

Constructor Summary

Constructors

Constructor and Description
SpecsHelper(org.jfrog.build.api.util.Log log)

Method Summary

Modifier and Type	Method and Description
static <K,V> com.google.common.collect.Multimap<K,V>	createMultiMap(java.util.Map<K,V> input)
java.util.List<org.jfrog.build.api.Dependency>	downloadArtifactsBySpec(java.lang.String spec, ArtifactoryManager client, java.lang.String targetDirectory) Downloads Artifacts by spec and returns a list of the downloaded dependencies.
boolean	editPropertiesBySpec(java.lang.String spec, ArtifactoryManager artifactoryManager, EditPropertiesHelper.EditPropertiesActionType editType, java.lang.String props)
static void	fillPropertiesMap(java.lang.String props, com.google.common.collect.ArrayListMultimap<java.lang.String,java.lang.String> propertiesMap)
static com.google.common.collect.ArrayListMultimap<java.lang.String,java.lang.String>	getPropertiesMap(java.lang.String props) Builds a map representing Spec's properties
Spec	getSpecFromFile(java.io.File specFile, SpecsValidator specsValidator) Converts File to Spec object
Spec	getSpecFromString(java.lang.String specStr, SpecsValidator specsValidator) Converts String to Spec object
java.util.List<org.jfrog.build.api.Artifact>	uploadArtifactsBySpec(java.lang.String uploadSpec, java.io.File workspace, java.util.Map<java.lang.String,java.lang.String> buildProperties, ArtifactoryManagerBuilder artifactoryManagerBuilder) Upload artifacts according to a given spec, return a list describing the deployed items.
java.util.List<org.jfrog.build.api.Artifact>	uploadArtifactsBySpec(java.lang.String uploadSpec, java.io.File workspace, com.google.common.collect.Multimap<java.lang.String,java.lang.String> buildProperties, ArtifactoryManagerBuilder artifactoryManagerBuilder) Upload artifacts according to a given spec, return a list describing the deployed items.
java.util.List<org.jfrog.build.api.Artifact>	uploadArtifactsBySpec(java.lang.String uploadSpec, int numberOfThreads, java.io.File workspace, com.google.common.collect.Multimap<java.lang.String,java.lang.String> buildProperties, ArtifactoryManagerBuilder artifactoryManagerBuilder) Upload artifacts according to a given spec, return a list describing the deployed items.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecsHelper

public SpecsHelper(org.jfrog.build.api.util.Log log)

Method Detail

uploadArtifactsBySpec

public java.util.List<org.jfrog.build.api.Artifact> uploadArtifactsBySpec(java.lang.String uploadSpec,
                                                                          java.io.File workspace,
                                                                          java.util.Map<java.lang.String,java.lang.String> buildProperties,
                                                                          ArtifactoryManagerBuilder artifactoryManagerBuilder)
                                                                   throws java.lang.Exception

Upload artifacts according to a given spec, return a list describing the deployed items. Retains compatibility with other plugins using file specs with default number of concurrent upload threads

Parameters:

uploadSpec - The required spec represented as String

workspace - File object that represents the workspace

buildProperties - Upload properties

artifactoryManagerBuilder - ArtifactoryManagerBuilder which will build the ArtifactoryManager to perform the actual upload

Returns:

Set of DeployDetails that was calculated from the given params

Throws:

java.io.IOException - Thrown if any error occurs while reading the file, calculating the checksums or in case of any file system exception

java.lang.Exception

uploadArtifactsBySpec

public java.util.List<org.jfrog.build.api.Artifact> uploadArtifactsBySpec(java.lang.String uploadSpec,
                                                                          java.io.File workspace,
                                                                          com.google.common.collect.Multimap<java.lang.String,java.lang.String> buildProperties,
                                                                          ArtifactoryManagerBuilder artifactoryManagerBuilder)
                                                                   throws java.lang.Exception

Upload artifacts according to a given spec, return a list describing the deployed items.

Parameters:

uploadSpec - The required spec represented as String

workspace - File object that represents the workspace

buildProperties - Upload properties

artifactoryManagerBuilder - ArtifactoryManagerBuilder which will build the ArtifactoryManager to perform the actual upload

Returns:

Set of DeployDetails that was calculated from the given params

Throws:

java.io.IOException - Thrown if any error occurs while reading the file, calculating the checksums or in case of any file system exception

java.lang.Exception

uploadArtifactsBySpec

public java.util.List<org.jfrog.build.api.Artifact> uploadArtifactsBySpec(java.lang.String uploadSpec,
                                                                          int numberOfThreads,
                                                                          java.io.File workspace,
                                                                          com.google.common.collect.Multimap<java.lang.String,java.lang.String> buildProperties,
                                                                          ArtifactoryManagerBuilder artifactoryManagerBuilder)
                                                                   throws java.lang.Exception

Upload artifacts according to a given spec, return a list describing the deployed items.

Parameters:

uploadSpec - The required spec represented as String

numberOfThreads - Number of concurrent threads to use for handling uploads

workspace - File object that represents the workspace

buildProperties - Upload properties

artifactoryManagerBuilder - ArtifactoryManagerBuilder which will build the ArtifactoryManager per the number of passed threads number to perform the actual upload

Returns:

Set of DeployDetails that was calculated from the given params

Throws:

java.io.IOException - Thrown if any error occurs while reading the file, calculating the checksums or in case of any file system exception

java.lang.Exception

createMultiMap

public static <K,V> com.google.common.collect.Multimap<K,V> createMultiMap(java.util.Map<K,V> input)

downloadArtifactsBySpec

public java.util.List<org.jfrog.build.api.Dependency> downloadArtifactsBySpec(java.lang.String spec,
                                                                              ArtifactoryManager client,
                                                                              java.lang.String targetDirectory)
                                                                       throws java.io.IOException

Downloads Artifacts by spec and returns a list of the downloaded dependencies. The artifacts will be downloaded using the provided client. In case of relative path the artifacts will be downloaded to the targetDirectory.

Parameters:

spec - the spec to use for download.

client - the client to use for download.

targetDirectory - the target directory in case of relative path in the spec

Returns:

A list of the downloaded dependencies.

Throws:

java.io.IOException - in case of IOException

getSpecFromFile

public Spec getSpecFromFile(java.io.File specFile,
                            SpecsValidator specsValidator)
                     throws java.io.IOException

Converts File to Spec object

Parameters:

specFile - the File to convert

Returns:

Spec object that represents the provided file

Throws:

java.io.IOException - in case of IO problem

getSpecFromString

public Spec getSpecFromString(java.lang.String specStr,
                              SpecsValidator specsValidator)
                       throws java.io.IOException

Converts String to Spec object

Parameters:

specStr - the String to convert

Returns:

Spec object that represents the string

Throws:

java.io.IOException - in case of IO problem

editPropertiesBySpec

public boolean editPropertiesBySpec(java.lang.String spec,
                                    ArtifactoryManager artifactoryManager,
                                    EditPropertiesHelper.EditPropertiesActionType editType,
                                    java.lang.String props)
                             throws java.io.IOException

Throws:

java.io.IOException

getPropertiesMap

public static com.google.common.collect.ArrayListMultimap<java.lang.String,java.lang.String> getPropertiesMap(java.lang.String props)

Builds a map representing Spec's properties

Parameters:

props - Spec's properties

Returns:

created properties map

fillPropertiesMap

public static void fillPropertiesMap(java.lang.String props,
                                     com.google.common.collect.ArrayListMultimap<java.lang.String,java.lang.String> propertiesMap)