org.jfrog.build.extractor.clientConfiguration.client

Class ArtifactoryBuildInfoClient

java.lang.Object

org.jfrog.build.extractor.clientConfiguration.client.ArtifactoryBaseClient

org.jfrog.build.extractor.clientConfiguration.client.ArtifactoryBuildInfoClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class ArtifactoryBuildInfoClient
extends ArtifactoryBaseClient
implements java.lang.AutoCloseable

Artifactory client to perform build info related tasks.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_JSON
static java.lang.String	APPLICATION_VND_ORG_JFROG_ARTIFACTORY_JSON
static java.lang.String	BUILD_BROWSE_URL
static java.lang.String	ITEM_LAST_MODIFIED

Fields inherited from class org.jfrog.build.extractor.clientConfiguration.client.ArtifactoryBaseClient

artifactoryUrl, httpClient, log

Constructor Summary

Constructors

Constructor and Description
ArtifactoryBuildInfoClient(java.lang.String artifactoryUrl, org.jfrog.build.api.util.Log log) Creates a new client for the given Artifactory url.
ArtifactoryBuildInfoClient(java.lang.String artifactoryUrl, java.lang.String username, java.lang.String password, org.jfrog.build.api.util.Log log) Creates a new client for the given Artifactory url.

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildInfoToJsonString(org.jfrog.build.api.Build buildInfo)
org.jfrog.build.client.ArtifactoryUploadResponse	deployArtifact(DeployDetails details) Deploys the artifact to the destination repository.
org.jfrog.build.client.ArtifactoryUploadResponse	deployArtifact(DeployDetails details, java.lang.String logPrefix) Deploys the artifact to the destination repository, with addition of prefix to the printed log.
org.apache.http.HttpResponse	distributeBuild(java.lang.String buildName, java.lang.String buildNumber, org.jfrog.build.api.release.Distribution promotion)
org.apache.http.HttpResponse	executePromotionUserPlugin(java.lang.String promotionName, java.lang.String buildName, java.lang.String buildNumber, java.util.Map<java.lang.String,java.lang.String> requestParams)
org.apache.http.HttpResponse	executeUpdateFileProperty(java.lang.String itemPath, java.lang.String properties)
org.apache.http.HttpResponse	executeUserPlugin(java.lang.String executionName, java.util.Map<java.lang.String,java.lang.String> requestParams)
org.jfrog.build.api.Build	getBuildInfo(java.lang.String buildName, java.lang.String buildNumber)
org.jfrog.build.client.ItemLastModified	getItemLastModified(java.lang.String path)
java.util.List<java.lang.String>	getLocalAndCacheRepositoriesKeys()
java.util.List<java.lang.String>	getLocalRepositoriesKeys()
java.util.List<java.lang.String>	getRemoteRepositoriesKeys()
java.util.Map	getStagingStrategy(java.lang.String strategyName, java.lang.String buildName, java.util.Map<java.lang.String,java.lang.String> requestParams)
java.util.Map<java.lang.String,java.util.List<java.util.Map>>	getUserPluginInfo()
java.util.List<java.lang.String>	getVirtualRepositoryKeys()
org.jfrog.build.client.bintrayResponse.BintrayResponse	pushToBintray(java.lang.String buildName, java.lang.String buildNumber, java.lang.String signMethod, java.lang.String passphrase, org.jfrog.build.api.release.BintrayUploadInfoOverride bintrayUploadInfo) Push build to bintray
void	sendBuildInfo(org.jfrog.build.api.Build buildInfo) Sends build info to Artifactory.
void	sendBuildInfo(java.lang.String buildInfoJson)
void	sendBuildRetetion(org.jfrog.build.api.BuildRetention buildRetention, java.lang.String buildName, boolean async)
void	sendModuleInfo(org.jfrog.build.api.Build build)
org.apache.http.HttpResponse	stageBuild(java.lang.String buildName, java.lang.String buildNumber, org.jfrog.build.api.release.Promotion promotion)
void	uploadChecksums(DeployDetails details, java.lang.String uploadUrl)
org.jfrog.build.client.ArtifactoryVersion	verifyCompatibleArtifactoryVersion()

Methods inherited from class org.jfrog.build.extractor.clientConfiguration.client.ArtifactoryBaseClient

close, getArtifactoryUrl, getArtifactoryVersion, isRepoExist, setConnectionRetries, setConnectionTimeout, setLog, setProxyConfiguration, setProxyConfiguration, setProxyConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

BUILD_BROWSE_URL

public static final java.lang.String BUILD_BROWSE_URL

See Also:

Constant Field Values

APPLICATION_VND_ORG_JFROG_ARTIFACTORY_JSON

public static final java.lang.String APPLICATION_VND_ORG_JFROG_ARTIFACTORY_JSON

See Also:

Constant Field Values

APPLICATION_JSON

public static final java.lang.String APPLICATION_JSON

See Also:

Constant Field Values

ITEM_LAST_MODIFIED

public static final java.lang.String ITEM_LAST_MODIFIED

See Also:

Constant Field Values

Constructor Detail

ArtifactoryBuildInfoClient

public ArtifactoryBuildInfoClient(java.lang.String artifactoryUrl,
                                  org.jfrog.build.api.util.Log log)

Creates a new client for the given Artifactory url.

Parameters:

artifactoryUrl - Artifactory url in the form of: protocol://host[:port]/contextPath

ArtifactoryBuildInfoClient

public ArtifactoryBuildInfoClient(java.lang.String artifactoryUrl,
                                  java.lang.String username,
                                  java.lang.String password,
                                  org.jfrog.build.api.util.Log log)

Creates a new client for the given Artifactory url.

Parameters:

artifactoryUrl - Artifactory url in the form of: protocol://host[:port]/contextPath

username - Authentication username

password - Authentication password

Method Detail

getLocalRepositoriesKeys

public java.util.List<java.lang.String> getLocalRepositoriesKeys()
                                                          throws java.io.IOException

Returns:

A list of local repositories available for deployment.

Throws:

java.io.IOException - On any connection error

getLocalAndCacheRepositoriesKeys

public java.util.List<java.lang.String> getLocalAndCacheRepositoriesKeys()
                                                                  throws java.io.IOException

Returns:

A list of local and cache repositories.

Throws:

java.io.IOException - On any connection error

getRemoteRepositoriesKeys

public java.util.List<java.lang.String> getRemoteRepositoriesKeys()
                                                           throws java.io.IOException

Returns:

A list of remote repositories.

Throws:

java.io.IOException - On any connection error

getVirtualRepositoryKeys

public java.util.List<java.lang.String> getVirtualRepositoryKeys()
                                                          throws java.io.IOException

Returns:

A list of virtual repositories available for resolution.

Throws:

java.io.IOException - On any connection error

sendBuildInfo

public void sendBuildInfo(java.lang.String buildInfoJson)
                   throws java.io.IOException

Throws:

java.io.IOException

getBuildInfo

public org.jfrog.build.api.Build getBuildInfo(java.lang.String buildName,
                                              java.lang.String buildNumber)
                                       throws java.io.IOException

Throws:

java.io.IOException

sendBuildRetetion

public void sendBuildRetetion(org.jfrog.build.api.BuildRetention buildRetention,
                              java.lang.String buildName,
                              boolean async)
                       throws java.io.IOException

Throws:

java.io.IOException

sendBuildInfo

public void sendBuildInfo(org.jfrog.build.api.Build buildInfo)
                   throws java.io.IOException

Sends build info to Artifactory.

Parameters:

buildInfo - The build info to send

Throws:

java.io.IOException - On any connection error

sendModuleInfo

public void sendModuleInfo(org.jfrog.build.api.Build build)
                    throws java.io.IOException

Throws:

java.io.IOException

getItemLastModified

public org.jfrog.build.client.ItemLastModified getItemLastModified(java.lang.String path)
                                                            throws java.io.IOException

Throws:

java.io.IOException

deployArtifact

public org.jfrog.build.client.ArtifactoryUploadResponse deployArtifact(DeployDetails details)
                                                                throws java.io.IOException

Deploys the artifact to the destination repository.

Parameters:

details - Details about the deployed artifact

Returns:

ArtifactoryResponse The response content received from Artifactory

Throws:

java.io.IOException - On any connection error

deployArtifact

public org.jfrog.build.client.ArtifactoryUploadResponse deployArtifact(DeployDetails details,
                                                                       java.lang.String logPrefix)
                                                                throws java.io.IOException

Deploys the artifact to the destination repository, with addition of prefix to the printed log.

Parameters:

details - Details about the deployed artifact

logPrefix - Will be printed as a log-prefix

Returns:

Throws:

java.io.IOException - On any connection error

verifyCompatibleArtifactoryVersion

public org.jfrog.build.client.ArtifactoryVersion verifyCompatibleArtifactoryVersion()
                                                                             throws org.jfrog.build.util.VersionException

Returns:

Artifactory version if working against a compatible version of Artifactory

Throws:

org.jfrog.build.util.VersionException

pushToBintray

public org.jfrog.build.client.bintrayResponse.BintrayResponse pushToBintray(java.lang.String buildName,
                                                                            java.lang.String buildNumber,
                                                                            java.lang.String signMethod,
                                                                            java.lang.String passphrase,
                                                                            org.jfrog.build.api.release.BintrayUploadInfoOverride bintrayUploadInfo)
                                                                     throws java.io.IOException,
                                                                            java.net.URISyntaxException

Push build to bintray

Parameters:

buildName - name of the build to push

buildNumber - number of the build to push

signMethod - flags if this artifacts should be signed or not

passphrase - passphrase in case that the artifacts should be signed

bintrayUploadInfo - request body which contains the upload info

Returns:

http Response with the response outcome

Throws:

java.io.IOException - On any connection error

java.net.URISyntaxException

stageBuild

public org.apache.http.HttpResponse stageBuild(java.lang.String buildName,
                                               java.lang.String buildNumber,
                                               org.jfrog.build.api.release.Promotion promotion)
                                        throws java.io.IOException

Throws:

java.io.IOException

distributeBuild

public org.apache.http.HttpResponse distributeBuild(java.lang.String buildName,
                                                    java.lang.String buildNumber,
                                                    org.jfrog.build.api.release.Distribution promotion)
                                             throws java.io.IOException

Throws:

java.io.IOException

getUserPluginInfo

public java.util.Map<java.lang.String,java.util.List<java.util.Map>> getUserPluginInfo()
                                                                                throws java.io.IOException

Throws:

java.io.IOException

executeUserPlugin

public org.apache.http.HttpResponse executeUserPlugin(java.lang.String executionName,
                                                      java.util.Map<java.lang.String,java.lang.String> requestParams)
                                               throws java.io.IOException

Throws:

java.io.IOException

getStagingStrategy

public java.util.Map getStagingStrategy(java.lang.String strategyName,
                                        java.lang.String buildName,
                                        java.util.Map<java.lang.String,java.lang.String> requestParams)
                                 throws java.io.IOException

Throws:

java.io.IOException

executePromotionUserPlugin

public org.apache.http.HttpResponse executePromotionUserPlugin(java.lang.String promotionName,
                                                               java.lang.String buildName,
                                                               java.lang.String buildNumber,
                                                               java.util.Map<java.lang.String,java.lang.String> requestParams)
                                                        throws java.io.IOException

Throws:

java.io.IOException

executeUpdateFileProperty

public org.apache.http.HttpResponse executeUpdateFileProperty(java.lang.String itemPath,
                                                              java.lang.String properties)
                                                       throws java.io.IOException

Throws:

java.io.IOException

buildInfoToJsonString

public java.lang.String buildInfoToJsonString(org.jfrog.build.api.Build buildInfo)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

uploadChecksums

public void uploadChecksums(DeployDetails details,
                            java.lang.String uploadUrl)
                     throws java.io.IOException

Throws:

java.io.IOException