com.urbancode.ds.jenkins.plugins.serenarapublisher
Class UrbanDeployPublisher

java.lang.Object
  hudson.tasks.BuildStepCompatibilityLayer
      hudson.tasks.Publisher
          hudson.tasks.Notifier
              com.urbancode.ds.jenkins.plugins.serenarapublisher.UrbanDeployPublisher

All Implemented Interfaces:

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

public class UrbanDeployPublisher
extends hudson.tasks.Notifier

This class implements the UrbanDeploy publisher process by using the UrbanDeploySite.

Nested Class Summary

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

static UrbanDeployPublisherDescriptor

DESCRIPTOR Hold an instance of the Descriptor implementation for the UrbanDeploy Publisher.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

UrbanDeployPublisher(String siteName, String component, String versionName, String directoryOffset, String baseDir, String fileIncludePatterns, String fileExcludePatterns, Boolean skip, Boolean deploy, String deployApp, String deployEnv, String deployProc)
Default constructor

Method Summary

String	getBaseDir()
String	getComponent()
String	getDeployApp()
String	getDeployEnv()
String	getDeployProc()
String	getDirectoryOffset()
String	getFileExcludePatterns()
String	getFileIncludePatterns()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
UrbanDeploySite	getSite() This method returns the configured UrbanDeploySite object which match the siteName of the UrbanDeployPublisher instance.
String	getSiteName()
String	getVersionName()
boolean	isDeploy()
boolean	isSkip()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
void	setBaseDir(String baseDir)
void	setComponent(String component)
void	setDeploy(boolean deploy)
void	setDeployApp(String deployApp)
void	setDeployEnv(String deployEnv)
void	setDeployProc(String deployProc)
void	setDirectoryOffset(String directoryOffset)
void	setFileExcludePatterns(String fileExcludePatterns)
void	setFileIncludePatterns(String fileIncludePatterns)
void	setSiteName(String siteName)
void	setSkip(boolean skip)
void	setVersionName(String versionName)

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTOR

@Extension
public static final UrbanDeployPublisherDescriptor DESCRIPTOR

Hold an instance of the Descriptor implementation for the UrbanDeploy Publisher.

Constructor Detail

UrbanDeployPublisher

public UrbanDeployPublisher(String siteName,
                            String component,
                            String versionName,
                            String directoryOffset,
                            String baseDir,
                            String fileIncludePatterns,
                            String fileExcludePatterns,
                            Boolean skip,
                            Boolean deploy,
                            String deployApp,
                            String deployEnv,
                            String deployProc)

Default constructor

Method Detail

getSiteName

public String getSiteName()

setSiteName

public void setSiteName(String siteName)

getComponent

public String getComponent()

setComponent

public void setComponent(String component)

getBaseDir

public String getBaseDir()

setBaseDir

public void setBaseDir(String baseDir)

getDirectoryOffset

public String getDirectoryOffset()

setDirectoryOffset

public void setDirectoryOffset(String directoryOffset)

getFileIncludePatterns

public String getFileIncludePatterns()

setFileIncludePatterns

public void setFileIncludePatterns(String fileIncludePatterns)

getFileExcludePatterns

public String getFileExcludePatterns()

setFileExcludePatterns

public void setFileExcludePatterns(String fileExcludePatterns)

getVersionName

public String getVersionName()

setVersionName

public void setVersionName(String versionName)

setSkip

public void setSkip(boolean skip)

isSkip

public boolean isSkip()

setDeploy

public void setDeploy(boolean deploy)

isDeploy

public boolean isDeploy()

setDeployApp

public void setDeployApp(String deployApp)

getDeployApp

public String getDeployApp()

setDeployEnv

public void setDeployEnv(String deployEnv)

getDeployEnv

public String getDeployEnv()

setDeployProc

public void setDeployProc(String deployProc)

getDeployProc

public String getDeployProc()

getSite

public UrbanDeploySite getSite()

This method returns the configured UrbanDeploySite object which match the siteName of the UrbanDeployPublisher instance. (see Manage Hudson and System Configuration point UrbanDeploy)

Returns:

the matching UrbanDeploySite or null

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build -

launcher -

listener -

Returns:

Throws:

InterruptedException

IOException

See Also:

hudson.tasks.BuildStep#perform(hudson.model.Build, hudson.Launcher, hudson.model.BuildListener)