org.jenkinsci.plugins.ftpRename

Class FtpRenameBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.ftpRename.FtpRenameBuilder

All Implemented Interfaces:

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

public class FtpRenameBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Sample Builder.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new FtpRenameBuilder is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields to remember the configuration.

When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) method will be invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FtpRenameBuilder.DescriptorImpl Descriptor for FtpRenameBuilder.

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
FtpRenameBuilder(String ftpServer, int ftpPort, String ftpUser, hudson.util.Secret ftpPassword, String ftpPath) Fields in config.jelly must match the parameter names in the "DataBoundConstructor"

Method Summary

Modifier and Type	Method and Description
String	getArtifactName()
FtpRenameBuilder.DescriptorImpl	getDescriptor()
String	getNewArtifactName()
String	getRemoteDirectory()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setArtifactName(String artifactName)
void	setNewArtifactName(String newArtifactName)
void	setRemoteDirectory(String remoteDirectory)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, 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, getRequiredMonitorService, perform, prebuild

Constructor Detail

FtpRenameBuilder

@DataBoundConstructor
public FtpRenameBuilder(String ftpServer,
                                               int ftpPort,
                                               String ftpUser,
                                               hudson.util.Secret ftpPassword,
                                               String ftpPath)

Fields in config.jelly must match the parameter names in the "DataBoundConstructor"

Parameters:

ftpServer - serverhost

ftpPort - server port

ftpUser - username

ftpPassword - password

ftpPath - artifact path filename

Method Detail

getArtifactName

public String getArtifactName()

setArtifactName

@DataBoundSetter
public void setArtifactName(String artifactName)

getNewArtifactName

public String getNewArtifactName()

setNewArtifactName

@DataBoundSetter
public void setNewArtifactName(String newArtifactName)

setRemoteDirectory

@DataBoundSetter
public void setRemoteDirectory(String remoteDirectory)

getRemoteDirectory

public String getRemoteDirectory()

perform

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

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException

getDescriptor

public FtpRenameBuilder.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder