Property Detail

• static final java.lang.Object CLI_CONFIG_NAME

  CLI config name.

  Default:

  "rt-server-1"

• static final java.lang.Object REPOSITORY_RELEASE

  Repository name for releases.

  Default:

  "libs-release-local"

• static final java.lang.Object REPOSITORY_SNAPSHOT

  Repository name for snapshots.

  Default:

  "libs-snapshot-local"

• java.lang.Object steps

  Reference to the groovy pipeline variable.

• java.lang.String url

  Artifactory URL.

  Example:

  https://zowe.jfrog.io/zowe

• java.lang.String usernamePasswordCredential

  Artifactory username/password credential id defined on Jenkins.

Constructor Detail

• JFrogArtifactory(java.lang.Object steps)

  Constructs the class.

  When invoking from a Jenkins pipeline script, the Pipeline must be passed the current environment of the Jenkinsfile to have access to the steps.

  Example:

   def jfrog = new JFrogArtifactory(this)
   

  Parameters:

  steps - The workflow steps object provided by the Jenkins pipeline

Method Detail

• java.util.Map delete(java.util.Map args = [:])

  Delete an artifact

  Note:

  This method is implemented with jFrog CLI.

  Example:

  Delete my-project.zip from artifactory {@coode lib-snapshot-local} repository.

       jfrog.delete(
           pattern : 'build/result/of/my-project.zip'
       )
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  pattern - pattern to locate the artifacts

  Returns:

  number of artifacts successfully or failed to delete

• java.util.Map delete(java.lang.String pattern)

  Delete an artifact

  See Also:

  upload(Map)

• void download(java.util.Map args = [:])

  Download artifacts

  Note:

  This method is implemented with jFrog CLI. The reason is sortBy in download spec is not supported by Jenkins Artifactory plugin.

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Example:

  Download 5 artifacts to local:

       jfrog.download(
           spec        : 'path/to/my/download/spec.json',
           expected    : 5
       )
   

  Or specify download spec in parameter

       jfrog.download(
           specContent : '[{"file": "lib-snapshot-local/path/to/file.zip"}]',
           expected    : 1
       )
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  spec - jfrog cli download specification file. optional.

  specContent - jfrog cli download specification content text. Will be ignored if 'spec' is defined, will be . required if 'spec' is not defined.

  expected - if we need to check download count. optional.

• java.util.Map getArtifact(java.util.Map args = [:])

  Get detail information of an artifact.

  Note:

  This method is implemented with jFrog CLI.

  Example output:

  • path - "libs-snapshot-local/com/project/zowe/0.9.0-SNAPSHOT/zowe-0.9.0-20180918.163158-38.pax"
  • build.name - "zowe-install-packaging :: master"
  • build.number - "38"
  • build.timestamp - "1537287202277"

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  throws:

  ArtifactException Cannot find or find more than one artifacts.

  Parameters:

  pattern - path pattern to find the artifact. For example: "lib-snapshot-local/path/to/artifacts/*.zip"

  build-name - limit the search within this build name. Optional.

  build-number - limit the search within this build number. Optional.

  Returns:

  a Map with the artifact information. Must include path key.

• java.util.Map getArtifact(java.lang.String pattern, java.lang.String buildName = '', java.lang.String buildNumber = '')

  Get detail information of an artifact.

  See Also:

  getArtifact(Map)

• java.lang.Object getArtifacts(java.util.Map args = [:])

  Get list of artifacts match the criteria

  Note:

  This method is implemented with jFrog CLI.

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  pattern - path pattern to find the artifact. For example: "lib-snapshot-local/path/to/artifacts/*.zip"

  build-name - limit the search within this build name. Optional.

  build-number - limit the search within this build number. Optional.

  Returns:

  a net.sf.json.JSONArray with the artifacts list

• java.util.Map getBuildInfo(java.util.Map args = [:])

  Get build information from Artifactory.

  Note:

  This method is implemented with jFrog API call.

  throws:

  ArtifactException Cannot find the build or other API failures.

  Parameters:

  build-name - limit the search within this build name. Required.

  build-number - limit the search within this build number. Required.

  Returns:

  full build information JSON object

• java.util.Map getBuildInfo(java.lang.String buildName, java.lang.String buildNumber)

  Get build information from Artifactory.

  See Also:

  getBuildInfo(Map)

• void init(java.util.Map args = [:])

  Initialize npm registry properties.

  Note:

  The below parameters are supported keys of the args Map.

  Parameters:

  url - the artifactory URL. For example "https://zowe.jfrog.io/zowe".

  usernamePasswordCredential - Artifactory username/password credential ID

• java.util.Map interpretArtifactDefinition(java.lang.String packageName, java.util.Map definition, java.util.Map defaults = [:])

  Interpret artifact definition

  Example:

  Consider these scenarios:

   "org.zowe.zlux.zlux-core": {
       // no * in the pattern, will pick exact artifact with path
       "artifact": "libs-snapshot-local/org/zowe/zlux/zlux-core/1.3.0-RC/zlux-core-1.3.0-20190607.143930.pax"
   },
   "org.zowe.explorer-jes": {
       // still pick exact artifact by release version
       // match 0.0.21 in libs-release-local/org/zowe/explorer-jes/0.0.21/*
       // and it should only have one artifact in the folder
       "version": "0.0.21"
   },
   "org.zowe.explorer-mvs": {
       // pick the most recent patch-level build
       // match 0.0.* from libs-snapshot-local/org/zowe/explorer-mvs/0.0.*/*
       "version": "~0.0.21",
       // optional to specify which artifact to pick from, if more than one in the folder
       // with this option, will try to find the artifact with pattern libs-snapshot-local/org/zowe/explorer-mvs/0.0.*/explorer-mvs-special-name-*.pax
       "artifact": "explorer-mvs-special-name-*.pax"
   },
   "org.zowe.another": {
       // pick the most recent minor-level build
       // match 0.* from libs-snapshot-local/org/zowe/another/0.*/*
       "version": "^0.0.21",
   },
   "license": {
       // pick exact artifact defined by artifact
       "artifact": "libs-release-local/org/zowe/licenses/1.0.0/zowe_licenses_full.zip"
   },
   "org.zowe.licenses": {
       // another way to define with same effect above
       "version": "1.0.0"
   }
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  packageName - package name. For example org.zowe.explorer-jes

  definition - map of definition. Supported keys are: version, artifact, explode, target, repository

  defaults - default values for definition. Supported keys are: target, repository

  Returns:

  map of Artifactory download spec

• java.util.Map interpretArtifactDefinitions(java.util.Map definitions, java.util.Map defaults = [:])

  Convert Map of package name - definition to Artifactory download specification

  Parameters:

  definitions - Map of package name - definition pairs

  defaults - default values for definition. Supported keys are: target, repository

  Returns:

  map of download spec with 'files' List

• java.lang.String promote(java.util.Map args = [:])

  Promote artifact.

  Requires these environment variables:

  • - JOB_NAME
  • - BUILD_NUMBER

  Example:

  Promote my-project-0.1.2-snapshot.zip as formal release of v0.1.2:

       String result = jfrog.promote(
           source     : 'lib-snapshot-local/org/zowe/my-project/0.1.2/my-project-0.1.2-snapshot.zip',
           targetPath : 'lib-release-local/org/zowe/my-project/0.1.2/',
           targetName : 'my-project-0.1.2.zip'
       )
       assert result == 'lib-release-local/org/zowe/my-project/0.1.2/my-project-0.1.2.zip'
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  source - information of the artifact will be promoted.

  targetPath - target path on remote Artifactory

  targetName - target artifact name. Optional, default to original name.

  Returns:

  full path to the promoted artifact

• java.lang.String promote(java.lang.String source, java.lang.String targetPath, java.lang.String targetName = '')

  Promote artifact.

  See Also:

  promote(Map)

• void upload(java.util.Map args = [:])

  Upload an artifact

  You can choose one of three ways to upload:

  • - specify spec which pointing to a file
  • - specify specContent which is upload specification text
  • - specify pattern and target, these information will be rendered into upload specification

  Example:

  Upload my-project.zip to artifactory {@coode lib-snapshot-local} repository.

       jfrog.upload(
           pattern : 'build/result/of/my-project.zip',
           target  : 'lib-snapshot-local/org/zowe/my-project/0.1.2/my-project-0.1.2-snapshot.zip'
       )
   

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  spec - jfrog cli upload specification file. optional.

  specContent - jfrog cli upload specification content text.

  pattern - pattern to find local artifact(s)

  target - target path on remote Artifactory

  properties - a map of extra properties we want to add to the artifact

• void upload(java.lang.String pattern, java.lang.String target, java.util.Map properties = [:])

  Upload an artifact.

  See Also:

  upload(Map)

• void uploadWithCli(java.util.Map args = [:])

  Upload an artifact.

  Requires these environment variables:

  • - JOB_NAME
  • - BUILD_NUMBER

  Note:

  Use similar parameters defined in init(Map) method and with these extra parameters:

  Parameters:

  pattern - pattern to find local artifact(s)

  target - target path on remote Artifactory