de.dentrassi.pm.jenkins

Class DroneRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

de.dentrassi.pm.jenkins.DroneRecorder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep, jenkins.tasks.SimpleBuildStep

public class DroneRecorder
extends hudson.tasks.Recorder
implements jenkins.tasks.SimpleBuildStep

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DroneRecorder.DescriptorImpl

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
DroneRecorder(String serverUrl, String channel, String credentialsId, String artifacts)

Method Summary

Modifier and Type	Method and Description
protected hudson.FilePath.FileCallable<UploaderResult>	createCallable(hudson.model.Run<?,?> run, LoggerListenerWrapper listener, String artifacts, ServerData serverData)
String	getArtifacts() Returns the ant glob pattern to includes files for the upload.
String	getChannel() Returns the channel id where upload collected files.
String	getCredentialsId() Returns the stored credentials id used as deploy key.
String	getDeployKey() Deprecated. Use {getCredentialsId() instead.
String	getExcludes() Returns the ant glob pattern to exclude files from the upload.
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getServerUrl() Returns the URL of the package drone server till the context root path.
boolean	isAllowEmptyArchive() Returns when mark the build as failed if there are no archives to upload.
boolean	isDefaultExcludes() Returns if use the ant default exclude when gather the files to upload.
boolean	isFailsAsUpload() Returns when mark the build as failed if an error was occurred during the archives upload.
boolean	isStripPath() Returns if the resource will be uploaded without its local path.
boolean	isUploadV3() Returns if the protocol to use in upload is V3.
void	perform(hudson.model.Run<?,?> run, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener taskListener)
void	setAllowEmptyArchive(boolean allowEmptyArchive) Sets when mark the build as failed if there are no archives to upload.
void	setDefaultExcludes(boolean defaultExcludes) Sets if use the default ant exclude pattern to exclude files to upload.
void	setDeployKey(String deployKey) Deprecated.
void	setExcludes(String excludes) Sets the ant glob pattern to exclude some files to upload.
void	setFailsAsUpload(boolean failsAsUpload) Sets when mark the build as failed if an error was occurred during the archives upload.
void	setStripPath(boolean stripPath) Sets if strip the path of the resources to upload.
void	setUploadV3(boolean uploadV3) Sets if use the protocol V3 to upload.

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Constructor Detail

DroneRecorder

@DataBoundConstructor
public DroneRecorder(String serverUrl,
                                           String channel,
                                           String credentialsId,
                                           String artifacts)

Method Detail

setExcludes

@DataBoundSetter
public void setExcludes(String excludes)

Sets the ant glob pattern to exclude some files to upload.

Parameters:

excludes - the ant glob pattern

setDefaultExcludes

@DataBoundSetter
public void setDefaultExcludes(boolean defaultExcludes)

Sets if use the default ant exclude pattern to exclude files to upload.

Parameters:

defaultExcludes - if use the default ant exclude paths.

setStripPath

@DataBoundSetter
public void setStripPath(boolean stripPath)

Sets if strip the path of the resources to upload.

Parameters:

stripPath - if upload only the resource with its filename.

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

setAllowEmptyArchive

@DataBoundSetter
public void setAllowEmptyArchive(boolean allowEmptyArchive)

Sets when mark the build as failed if there are no archives to upload.

Parameters:

allowEmptyArchive - if is the build has to be marked as failed.

setFailsAsUpload

@DataBoundSetter
public void setFailsAsUpload(boolean failsAsUpload)

Sets when mark the build as failed if an error was occurred during the archives upload.

Parameters:

failsAsUpload - if the build has to be marked as failed.

setUploadV3

@DataBoundSetter
public void setUploadV3(boolean uploadV3)

Sets if use the protocol V3 to upload.

This protocol is available since package drone server version 0.14.0 .

Parameters:

uploadV3 - if use the V3 protocol.

setDeployKey

@Deprecated
 @DataBoundSetter
public void setDeployKey(String deployKey)

Deprecated.

getServerUrl

public String getServerUrl()

Returns the URL of the package drone server till the context root path.

Returns:

the package drone server URL string

getArtifacts

public String getArtifacts()

Returns the ant glob pattern to includes files for the upload.

Returns:

the include ant glob pattern.

getExcludes

public String getExcludes()

Returns the ant glob pattern to exclude files from the upload.

Returns:

the exclude ant glob pattern.

getChannel

public String getChannel()

Returns the channel id where upload collected files.

Returns:

the channel id

getCredentialsId

public String getCredentialsId()

Returns the stored credentials id used as deploy key.

Returns:

credentials id

getDeployKey

@Deprecated
public String getDeployKey()

Deprecated. Use {getCredentialsId() instead.

Returns the deploy key.

Returns:

deploy key

isDefaultExcludes

public boolean isDefaultExcludes()

Returns if use the ant default exclude when gather the files to upload.

Refers to the ant documentation for the complete list of default excludes here: http://ant.apache.org/manual/dirtasks.html#defaultexcludes

Returns:

true is use default, false otherwise.

isStripPath

public boolean isStripPath()

Returns if the resource will be uploaded without its local path.

Returns:

true if strip the path, false otherwise

isAllowEmptyArchive

public boolean isAllowEmptyArchive()

Returns when mark the build as failed if there are no archives to upload.

Returns:

true is the build has to be marked as failed, false otherwise

isFailsAsUpload

public boolean isFailsAsUpload()

Returns when mark the build as failed if an error was occurred during the archives upload.

Returns:

true is the build has to be marked as failed, false otherwise.

isUploadV3

public boolean isUploadV3()

Returns if the protocol to use in upload is V3.

This protocol is available since package drone server version 0.14.0 .

Returns:

true if use the V3 protocol, false otherwise

perform

public void perform(hudson.model.Run<?,?> run,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener taskListener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

createCallable

protected hudson.FilePath.FileCallable<UploaderResult> createCallable(hudson.model.Run<?,?> run,
                                                                      LoggerListenerWrapper listener,
                                                                      String artifacts,
                                                                      ServerData serverData)