org.jenkinsci.plugins.pipeline.utility.steps.zip

Class UnZipStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.pipeline.utility.steps.zip.UnZipStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class UnZipStep
extends org.jenkinsci.plugins.workflow.steps.Step

Unzips a zip file. Can also be used to test a zip file.

Author:

Robert Sandell <rsandell@cloudbees.com>.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnZipStep.DescriptorImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
UnZipStep(String zipFile)

Method Summary

Modifier and Type	Method and Description
String	getCharset() Get the charset to use when unzipping the zip file.
String	getDir() The relative path of the base directory to create the zip from.
String	getGlob() Ant style pattern of files to extract from the zip.
String	getZipFile() The name/path of the zip file to extract.
boolean	isQuiet() Suppress the verbose output that logs every single file that is dealt with.
boolean	isRead() Read the content of the files into a String instead of writing them to the workspace.
boolean	isTest() Test the integrity of the archive instead of extracting it.
void	setCharset(String charset) Set the charset to use when unzipping the zip file.
void	setDir(String dir) The relative path of the base directory to create the zip from.
void	setGlob(String glob) Ant style pattern of files to extract from the zip.
void	setQuiet(boolean quiet) Suppress the verbose output that logs every single file that is dealt with.
void	setRead(boolean read) Read the content of the files into a String instead of writing them to the workspace.
void	setTest(boolean test) Test the integrity of the archive instead of extracting it.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext context)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

UnZipStep

@DataBoundConstructor
public UnZipStep(String zipFile)
                                throws hudson.model.Descriptor.FormException

Throws:

hudson.model.Descriptor.FormException

Method Detail

getZipFile

public String getZipFile()

The name/path of the zip file to extract.

Returns:

the path

getDir

public String getDir()

The relative path of the base directory to create the zip from. Leave empty to create from the current working directory.

Returns:

the dir

setDir

@DataBoundSetter
public void setDir(String dir)

The relative path of the base directory to create the zip from. Leave empty to create from the current working directory.

Parameters:

dir - the dir

getGlob

public String getGlob()

Ant style pattern of files to extract from the zip. Leave empty to include all files and directories.

Returns:

the include pattern

setGlob

@DataBoundSetter
public void setGlob(String glob)

Ant style pattern of files to extract from the zip. Leave empty to include all files and directories.

Parameters:

glob - the include pattern

isTest

public boolean isTest()

Test the integrity of the archive instead of extracting it. When this parameter is enabled, all other parameters (except for getZipFile()) will be ignored. The step will return true or false depending on the result instead of throwing an exception.

Returns:

if the archive should just be tested or not

setTest

@DataBoundSetter
public void setTest(boolean test)

Test the integrity of the archive instead of extracting it. When this parameter is enabled, all other parameters (except for getZipFile()) will be ignored. The step will return true or false depending on the result instead of throwing an exception.

Parameters:

test - if the archive should just be tested or not

isRead

public boolean isRead()

Read the content of the files into a String instead of writing them to the workspace. E.g. String version = unzip zipFile: 'example.zip', glob: 'version.txt', read: true

Returns:

if the content should be read to a string instead of written to the workspace

setRead

@DataBoundSetter
public void setRead(boolean read)

Read the content of the files into a String instead of writing them to the workspace. E.g. String version = unzip zipFile: 'example.zip', glob: 'version.txt', read: true

Parameters:

read - if the content should be read to a string instead of written to the workspace

getCharset

public String getCharset()

Get the charset to use when unzipping the zip file. E.g. UTF-8 String version = unzip zipFile: 'example.zip', glob: 'version.txt', read: true, charset: UTF-8

Returns:

String specifying the charset, defaults to UTF-8

setCharset

@DataBoundSetter
public void setCharset(String charset)

Set the charset to use when unzipping the zip file. String version = unzip zipFile: 'example.zip', glob: 'version.txt', read: true , charset: UTF-8

Parameters:

charset - the charset to use when unzipping, defaults to UTF-8

isQuiet

public boolean isQuiet()

Suppress the verbose output that logs every single file that is dealt with. E.g. unzip zipFile: 'example.zip', glob: 'version.txt', quiet: true

Returns:

if verbose logging should be suppressed

setQuiet

@DataBoundSetter
public void setQuiet(boolean quiet)

Suppress the verbose output that logs every single file that is dealt with. E.g. unzip zipFile: 'example.zip', glob: 'version.txt', quiet: true

Parameters:

quiet - if verbose logging should be suppressed

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext context)
                                                         throws Exception

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Throws:

Exception