Property Detail

• static final java.lang.String DEFAULT_LOCAL_WORKSPACE

  Constant of default local workspace folder.

  Default:

  ".pax"

• static final java.lang.String DEFAULT_REMOTE_WORKSPACE

  Constant of default remote workspace folder.

  Default:

  "/tmp"

• static final java.lang.String HOOK_CATCHALL_PACKAGING

  Constant of catchall-packaging hook

  Note:

  This hook script runs on remote workspace.

  Default:

  "catchall-packaging.sh"

• static final java.lang.String HOOK_POST_PACKAGING

  Constant of post-packaging hook

  Note:

  This hook script runs on remote workspace.

  Default:

  "post-packaging.sh"

• static final java.lang.String HOOK_PREPARE_WORKSPACE

  Constant of prepare-packaging hook name

  Note:

  This hook script runs on local workspace.

  Default:

  "prepare-workspace.sh"

• static final java.lang.String HOOK_PRE_PACKAGING

  Constant of pre-packaging hook

  Note:

  This hook script runs on remote workspace.

  Default:

  "pre-packaging.sh"

• static final java.lang.String PATH_ASCII

  Constant of local ascii folder name

  Default:

  "ascii"

• static final java.lang.String PATH_CONTENT

  Constant of local content folder name

  Default:

  "content"

• java.lang.String localWorkspace

  Local workspace folder name

• java.lang.String remoteWorkspace

  Remote workspace folder name

• java.lang.String sshCredential

  SSH server credential ID

  The content of token could be base64 encoded "username:password".

• java.lang.String sshHost

  SSH server to run pax

• java.lang.String sshPort

  SSH server port

  Default:

  22

• java.lang.Object steps

  Reference to the groovy pipeline variable.

Constructor Detail

• Pax(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 pax = new Pax(this)
   

  Parameters:

  steps - The workflow steps object provided by the Jenkins pipeline

Method Detail

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

  Initialize pax packaging properties

  Parameters:

  localWorkspace - workspace folder on local. Default value is DEFAULT_LOCAL_WORKSPACE.

  remoteWorkspace - workspace folder on remote (ssh server). Default value is DEFAULT_REMOTE_WORKSPACE.

  sshHost - hostname/ip of packaging server

  sshPort - ssh port of packaging server

  sshCredential - SSH credential of packaging server

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

  Create PAX Package

  Note:

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

  Parameters:

  job - job identifier

  filename - package file name will be created

  extraFiles - extra artifacts will be generated and should be transferred back

  environments - environment variables

  paxOptions - pax write command options

  compress - if we want to compress the result

  compressOptions - compress command options

  keepTempFolder - if we want to keep the temporary packaging folder on the remote machine for debugging purpose. Default is false.

  Returns:

  pax package created

• java.lang.String pack(java.lang.String job, java.lang.String filename, java.util.Map environments = [:], java.lang.String paxOptions = '')

  Create PAX Package

  Note:

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

  See Also:

  pack(Map)

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

  Extract PAX Package to remoteWorkspace

  Note:

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

  Parameters:

  filename - package file name will be extracted

  paxOptions - pax extract command options

  Returns:

  pax package content list with "find . -print"

• java.lang.String unpack(java.lang.String filename, java.lang.String remoteWorkspace, java.lang.String paxOptions = '')

  Extract PAX Package to remoteWorkspace

  Note:

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

  See Also:

  unpack(Map)