Constants (jenkins-library 1.4.0 API)

jenkins_shared_library.Constants

Constants used by Jenkins Shared Library.
Note:
The default account information for various services we are using are also defined here. We strongly recommended the library consumer to use these constants. This will make us really easy to migrate service to another location.

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_ARTIFACTORY_ROBOT_CREDENTIAL`	Default Artifactory robot account Jenkins username/password credential ID
`static java.lang.String`	`DEFAULT_ARTIFACTORY_URL`	Default Artifactory URL
`static java.lang.Boolean`	`DEFAULT_DISABLE_SONARQUBE_GRADLE_PLUGIN`	Default if pipeline should use gradle SonarQube plugin to run SonarQube scan.
`static java.lang.String`	`DEFAULT_DOCKER_IMAGE_PREFIX`	Default Docker image prefix
`static java.lang.String`	`DEFAULT_DOCKER_REGISTRY_CREDENTIAL`	Default Docker registry robot account credential on Jenkins
`static java.lang.String`	`DEFAULT_DOCKER_REGISTRY_URL`	Default Docker registry url
`static java.lang.String`	`DEFAULT_GITHUB_ROBOT_CREDENTIAL`	Default GitHub robot account Jenkins username/password credential ID
`static java.lang.String`	`DEFAULT_GITHUB_ROBOT_EMAIL`	Default GitHub robot account email
`static java.lang.String`	`DEFAULT_GPG_CODE_SIGNING_KEY_PASSPHRASE`	Default GnuPG Code Signing Key Passphrase Jenkins username/password credential
`static java.lang.String`	`DEFAULT_GPG_CODE_SIGNING_PRIVATE_KEY_FILE`	Default GnuPG Code Signing Private Key Jenkins Secret file credential
`static java.lang.String`	`DEFAULT_LFJ_ARTIFACTORY_ROBOT_CREDENTIAL`	Default LF Artifactory robot account Jenkins username/password credential ID
`static java.lang.String`	`DEFAULT_LFJ_ARTIFACTORY_URL`	Default Artifactory URL provided by LF
`static java.lang.Boolean`	`DEFAULT_LFJ_DISABLE_SONARQUBE_GRADLE_PLUGIN`	Default if pipeline should use gradle SonarQube plugin to run SonarQube scan on LF SonarCloud.
`static java.lang.String`	`DEFAULT_LFJ_DOCKER_IMAGE_PREFIX`	Default Docker image prefix
`static java.lang.String`	`DEFAULT_LFJ_DOCKER_REGISTRY_CREDENTIAL`	Default Docker registry robot account credential on Jenkins
`static java.lang.String`	`DEFAULT_LFJ_DOCKER_REGISTRY_URL`	Default Docker registry url
`static java.lang.String`	`DEFAULT_LFJ_GITHUB_ROBOT_CREDENTIAL`	Default GitHub robot account LF enkins username/password credential ID
`static java.lang.String`	`DEFAULT_LFJ_GITHUB_ROBOT_SSH_CREDENTIAL`	Default GitHub robot account LF enkins username/password credential ID
`static java.lang.String`	`DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_CREDENTIAL`	Default NPM private registry robot account credential on Jenkins
`static java.lang.String`	`DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_EMAIL`	Default NPM private registry robot account email.
`static java.lang.String`	`DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_INSTALL`	Default NPM private registry url for npm install
`static java.lang.String`	`DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_PUBLISH`	Default NPM private registry url for npm publish
`static java.lang.Boolean`	`DEFAULT_LFJ_SONARCLOUD_ALLOW_BRANCH`	Default if SonarCloud server supports branch scanning
`static java.lang.Boolean`	`DEFAULT_LFJ_SONARCLOUD_FAIL_BUILD`	Default if pipeline should fail the build if code doesn't meet SonarCloud Scan Quality Gate.
`static java.lang.String`	`DEFAULT_LFJ_SONARCLOUD_SCANNER_TOOL`	Default SonarCloud scanner tool ID defined on Jenkins
`static java.lang.String`	`DEFAULT_LFJ_SONARCLOUD_SERVER`	Default SonarCloud server ID defined on Jenkins
`static java.util.logging.Level`	`DEFAULT_LOGGING_LEVEL`	Default logging level.
`static java.lang.String`	`DEFAULT_NPM_PRIVATE_REGISTRY_CREDENTIAL`	Default NPM private registry robot account credential on Jenkins
`static java.lang.String`	`DEFAULT_NPM_PRIVATE_REGISTRY_EMAIL`	Default NPM private registry robot account email
`static java.lang.String`	`DEFAULT_NPM_PRIVATE_REGISTRY_INSTALL`	Default NPM private registry url for npm install
`static java.lang.String`	`DEFAULT_NPM_PRIVATE_REGISTRY_PUBLISH`	Default NPM private registry url for npm publish
`static java.lang.String`	`DEFAULT_PAX_PACKAGING_REMOTE_WORKSPACE`	Default PAX Packaging server default working space
`static java.lang.String`	`DEFAULT_PAX_PACKAGING_SSH_CREDENTIAL`	Default PAX Packaging server credential defined on Jenkins
`static java.lang.String`	`DEFAULT_PAX_PACKAGING_SSH_HOST`	Default PAX Packaging server host name
`static java.lang.String`	`DEFAULT_PAX_PACKAGING_SSH_PORT`	Default PAX Packaging server port
`static java.lang.Boolean`	`DEFAULT_SONARQUBE_ALLOW_BRANCH`	Default if SonarQube server supports branch scanning
`static java.lang.Boolean`	`DEFAULT_SONARQUBE_FAIL_BUILD`	Default if pipeline should fail the build if code doesn't meet Sonar Scan Quality Gate.
`static java.lang.String`	`DEFAULT_SONARQUBE_SCANNER_TOOL`	Default SonarQube scanner tool ID defined on Jenkins
`static java.lang.String`	`DEFAULT_SONARQUBE_SERVER`	Default SonarQube server ID defined on Jenkins
`static java.lang.String`	`REPOSITORY_JENKINS_LIBRARY`	Repository name of this jenkins library.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static java.lang.String DEFAULT_ARTIFACTORY_ROBOT_CREDENTIAL
    
    Default Artifactory robot account Jenkins username/password credential ID
    Default:
    "zowe.jfrog.io"
  - public static java.lang.String DEFAULT_ARTIFACTORY_URL
    
    Default Artifactory URL
    Default:
    "https://zowe.jfrog.io/zowe"
  - public static java.lang.Boolean DEFAULT_DISABLE_SONARQUBE_GRADLE_PLUGIN
    
    Default if pipeline should use gradle SonarQube plugin to run SonarQube scan.
    Default:
    false
  - public static java.lang.String DEFAULT_DOCKER_IMAGE_PREFIX
    
    Default Docker image prefix
    Default:
    "jackjiaibm"
  - public static java.lang.String DEFAULT_DOCKER_REGISTRY_CREDENTIAL
    
    Default Docker registry robot account credential on Jenkins
    Default:
    "jackjia-docker-access-token"
  - public static java.lang.String DEFAULT_DOCKER_REGISTRY_URL
    
    Default Docker registry url
    Default:
    ""
  - public static java.lang.String DEFAULT_GITHUB_ROBOT_CREDENTIAL
    
    Default GitHub robot account Jenkins username/password credential ID
    Default:
    "zowe-robot-github"
  - public static java.lang.String DEFAULT_GITHUB_ROBOT_EMAIL
    
    Default GitHub robot account email
    Default:
    "zowe.robot@gmail.com"
  - public static java.lang.String DEFAULT_GPG_CODE_SIGNING_KEY_PASSPHRASE
    
    Default GnuPG Code Signing Key Passphrase Jenkins username/password credential
    Default:
    "code-signing-key-passphrase-jack"
  - public static java.lang.String DEFAULT_GPG_CODE_SIGNING_PRIVATE_KEY_FILE
    
    Default GnuPG Code Signing Private Key Jenkins Secret file credential
    Default:
    "code-signing-key-private-jack"
  - public static java.lang.String DEFAULT_LFJ_ARTIFACTORY_ROBOT_CREDENTIAL
    
    Default LF Artifactory robot account Jenkins username/password credential ID
    Default:
    "zowe.jfrog.io"
  - public static java.lang.String DEFAULT_LFJ_ARTIFACTORY_URL
    
    Default Artifactory URL provided by LF
    Default:
    "https://zowe.jfrog.io/zowe"
  - public static java.lang.Boolean DEFAULT_LFJ_DISABLE_SONARQUBE_GRADLE_PLUGIN
    
    Default if pipeline should use gradle SonarQube plugin to run SonarQube scan on LF SonarCloud.
    Default:
    false
  - public static java.lang.String DEFAULT_LFJ_DOCKER_IMAGE_PREFIX
    
    Default Docker image prefix
    Default:
    "zowedockerhub"
  - public static java.lang.String DEFAULT_LFJ_DOCKER_REGISTRY_CREDENTIAL
    
    Default Docker registry robot account credential on Jenkins
    Default:
    "zowe_dockerhub_creds"
  - public static java.lang.String DEFAULT_LFJ_DOCKER_REGISTRY_URL
    
    Default Docker registry url
    Default:
    ""
  - public static java.lang.String DEFAULT_LFJ_GITHUB_ROBOT_CREDENTIAL
    
    Default GitHub robot account LF enkins username/password credential ID
    Default:
    "zowe-github"
  - public static java.lang.String DEFAULT_LFJ_GITHUB_ROBOT_SSH_CREDENTIAL
    
    Default GitHub robot account LF enkins username/password credential ID
    Default:
    "zowe-github-ssh"
  - public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_CREDENTIAL
    
    Default NPM private registry robot account credential on Jenkins
    Default:
    "zowe.jfrog.io"
  - public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_EMAIL
    
    Default NPM private registry robot account email.
    Note:
    This is not the real email associated with account. Will this cause problem?
    Default:
    "zowe.robot@gmail.com"
  - public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_INSTALL
    
    Default NPM private registry url for npm install
    Default:
    "https://zowe.jfrog.io/zowe/api/npm/npm-release/"
  - public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_PUBLISH
    
    Default NPM private registry url for npm publish
    Default:
    "https://zowe.jfrog.io/zowe/api/npm/npm-local-release/"
  - public static java.lang.Boolean DEFAULT_LFJ_SONARCLOUD_ALLOW_BRANCH
    
    Default if SonarCloud server supports branch scanning
    Default:
    true
  - public static java.lang.Boolean DEFAULT_LFJ_SONARCLOUD_FAIL_BUILD
    
    Default if pipeline should fail the build if code doesn't meet SonarCloud Scan Quality Gate.
    Default:
    true
  - public static java.lang.String DEFAULT_LFJ_SONARCLOUD_SCANNER_TOOL
    
    Default SonarCloud scanner tool ID defined on Jenkins
    Default:
    "sonar-scanner-4.0.0"
  - public static java.lang.String DEFAULT_LFJ_SONARCLOUD_SERVER
    
    Default SonarCloud server ID defined on Jenkins
    Default:
    "sonarcloud-server"
  - public static java.util.logging.Level DEFAULT_LOGGING_LEVEL
    
    Default logging level.
    Default:
    Level.INFO
  - public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_CREDENTIAL
    
    Default NPM private registry robot account credential on Jenkins
    Default:
    "zowe.jfrog.io"
  - public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_EMAIL
    
    Default NPM private registry robot account email
    Default:
    "zowe.robot@gmail.com"
  - public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_INSTALL
    
    Default NPM private registry url for npm install
    Default:
    "https://zowe.jfrog.io/zowe/api/npm/npm-release/"
  - public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_PUBLISH
    
    Default NPM private registry url for npm publish
    Default:
    "https://zowe.jfrog.io/zowe/api/npm/npm-local-release/"
  - public static java.lang.String DEFAULT_PAX_PACKAGING_REMOTE_WORKSPACE
    
    Default PAX Packaging server default working space
    Default:
    "/ZOWE/tmp"
  - public static java.lang.String DEFAULT_PAX_PACKAGING_SSH_CREDENTIAL
    
    Default PAX Packaging server credential defined on Jenkins
    Default:
    "ssh-marist-server-zzow01"
  - public static java.lang.String DEFAULT_PAX_PACKAGING_SSH_HOST
    
    Default PAX Packaging server host name
    Default:
    "zzow01.zowe.marist.cloud"
  - public static java.lang.String DEFAULT_PAX_PACKAGING_SSH_PORT
    
    Default PAX Packaging server port
    Default:
    "22"
  - public static java.lang.Boolean DEFAULT_SONARQUBE_ALLOW_BRANCH
    
    Default if SonarQube server supports branch scanning
    Default:
    false
  - public static java.lang.Boolean DEFAULT_SONARQUBE_FAIL_BUILD
    
    Default if pipeline should fail the build if code doesn't meet Sonar Scan Quality Gate.
    Default:
    false
  - public static java.lang.String DEFAULT_SONARQUBE_SCANNER_TOOL
    
    Default SonarQube scanner tool ID defined on Jenkins
    Default:
    "sonar-scanner-3.2.0"
  - public static java.lang.String DEFAULT_SONARQUBE_SERVER
    
    Default SonarQube server ID defined on Jenkins
    Default:
    "sonar-default-server"
  - public static java.lang.String REPOSITORY_JENKINS_LIBRARY
    
    Repository name of this jenkins library.
    Default:
    "zowe/jenkins-library"

Summary:
Field

| Detail:
Field

Groovy Documentation

[Groovy] Class Constants

Field Summary

Inherited Methods Summary

Field Detail

public static java.lang.String DEFAULT_ARTIFACTORY_ROBOT_CREDENTIAL

public static java.lang.String DEFAULT_ARTIFACTORY_URL

public static java.lang.Boolean DEFAULT_DISABLE_SONARQUBE_GRADLE_PLUGIN

public static java.lang.String DEFAULT_DOCKER_IMAGE_PREFIX

public static java.lang.String DEFAULT_DOCKER_REGISTRY_CREDENTIAL

public static java.lang.String DEFAULT_DOCKER_REGISTRY_URL

public static java.lang.String DEFAULT_GITHUB_ROBOT_CREDENTIAL

public static java.lang.String DEFAULT_GITHUB_ROBOT_EMAIL

public static java.lang.String DEFAULT_GPG_CODE_SIGNING_KEY_PASSPHRASE

public static java.lang.String DEFAULT_GPG_CODE_SIGNING_PRIVATE_KEY_FILE

public static java.lang.String DEFAULT_LFJ_ARTIFACTORY_ROBOT_CREDENTIAL

public static java.lang.String DEFAULT_LFJ_ARTIFACTORY_URL

public static java.lang.Boolean DEFAULT_LFJ_DISABLE_SONARQUBE_GRADLE_PLUGIN

public static java.lang.String DEFAULT_LFJ_DOCKER_IMAGE_PREFIX

public static java.lang.String DEFAULT_LFJ_DOCKER_REGISTRY_CREDENTIAL

public static java.lang.String DEFAULT_LFJ_DOCKER_REGISTRY_URL

public static java.lang.String DEFAULT_LFJ_GITHUB_ROBOT_CREDENTIAL

public static java.lang.String DEFAULT_LFJ_GITHUB_ROBOT_SSH_CREDENTIAL

public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_CREDENTIAL

public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_EMAIL

public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_INSTALL

public static java.lang.String DEFAULT_LFJ_NPM_PRIVATE_REGISTRY_PUBLISH

public static java.lang.Boolean DEFAULT_LFJ_SONARCLOUD_ALLOW_BRANCH

public static java.lang.Boolean DEFAULT_LFJ_SONARCLOUD_FAIL_BUILD

public static java.lang.String DEFAULT_LFJ_SONARCLOUD_SCANNER_TOOL

public static java.lang.String DEFAULT_LFJ_SONARCLOUD_SERVER

public static java.util.logging.Level DEFAULT_LOGGING_LEVEL

public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_CREDENTIAL

public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_EMAIL

public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_INSTALL

public static java.lang.String DEFAULT_NPM_PRIVATE_REGISTRY_PUBLISH

public static java.lang.String DEFAULT_PAX_PACKAGING_REMOTE_WORKSPACE

public static java.lang.String DEFAULT_PAX_PACKAGING_SSH_CREDENTIAL

public static java.lang.String DEFAULT_PAX_PACKAGING_SSH_HOST

public static java.lang.String DEFAULT_PAX_PACKAGING_SSH_PORT

public static java.lang.Boolean DEFAULT_SONARQUBE_ALLOW_BRANCH

public static java.lang.Boolean DEFAULT_SONARQUBE_FAIL_BUILD

public static java.lang.String DEFAULT_SONARQUBE_SCANNER_TOOL

public static java.lang.String DEFAULT_SONARQUBE_SERVER

public static java.lang.String REPOSITORY_JENKINS_LIBRARY