com.hpe.cloudfoundryjenkins

Class CloudFoundryPushPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.hpe.cloudfoundryjenkins.CloudFoundryPushPublisher

All Implemented Interfaces:

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

public class CloudFoundryPushPublisher
extends hudson.tasks.Recorder

Post-build action for pushing to CloudFoundry.

Author:

williamg, Steven Swor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudFoundryPushPublisher.DescriptorImpl
static class	CloudFoundryPushPublisher.EnvironmentVariable
static class	CloudFoundryPushPublisher.ManifestChoice This class contains the choice of using either a manifest file or the optional Jenkins configuration.
static class	CloudFoundryPushPublisher.Service
static class	CloudFoundryPushPublisher.ServiceName

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

Fields

Modifier and Type	Field and Description
String	cloudSpace The cloudfoundry space.
String	credentialsId The jenkins credentials id for cloudfoundry.
CloudFoundryPushPublisher.ManifestChoice	manifestChoice Manifest to use.
String	organization The cloudfoundry organization.
int	pluginTimeout Timeout for all cloudfoundry api calls.
boolean	resetIfExists Whether to reset the app if it already existed.
boolean	selfSigned Whether to ignore ssl validation errors.
List<CloudFoundryPushPublisher.Service>	servicesToCreate Services to create before pushing.
String	target The cloudfoundry api target.

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
CloudFoundryPushPublisher(String target, String organization, String cloudSpace, String credentialsId, boolean selfSigned, boolean resetIfExists, int pluginTimeout, List<CloudFoundryPushPublisher.Service> servicesToCreate, CloudFoundryPushPublisher.ManifestChoice manifestChoice) The constructor is databound from the Jenkins config page, which is defined in config.jelly.

Method Summary

Modifier and Type	Method and Description
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() Gets the required monitor service (NONE).
boolean	isResetIfExists()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) This is the main method, which gets called when the plugin must run as part of a build.

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, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

target

public String target

The cloudfoundry api target.

organization

public String organization

The cloudfoundry organization.

cloudSpace

public String cloudSpace

The cloudfoundry space.

credentialsId

public String credentialsId

The jenkins credentials id for cloudfoundry.

selfSigned

public boolean selfSigned

Whether to ignore ssl validation errors.

resetIfExists

public boolean resetIfExists

Whether to reset the app if it already existed. Note: Since version 2.0 of the plugin, this setting has no effect.

pluginTimeout

public int pluginTimeout

Timeout for all cloudfoundry api calls.

servicesToCreate

public List<CloudFoundryPushPublisher.Service> servicesToCreate

Services to create before pushing.

manifestChoice

public CloudFoundryPushPublisher.ManifestChoice manifestChoice

Manifest to use.

Constructor Detail

CloudFoundryPushPublisher

@DataBoundConstructor
public CloudFoundryPushPublisher(String target,
                                                       String organization,
                                                       String cloudSpace,
                                                       String credentialsId,
                                                       boolean selfSigned,
                                                       boolean resetIfExists,
                                                       int pluginTimeout,
                                                       List<CloudFoundryPushPublisher.Service> servicesToCreate,
                                                       CloudFoundryPushPublisher.ManifestChoice manifestChoice)

The constructor is databound from the Jenkins config page, which is defined in config.jelly.

Parameters:

target - the cloudfoundry api target

organization - the cloudfoundry organization

cloudSpace - the cloudfoundry space

credentialsId - the credentials to use

selfSigned - true to ignore ssl validation errors

resetIfExists - true to reset the app if it already exists (Note: since version 2.0 of the plugin, this setting has no effect).

pluginTimeout - the timeout for cloudfoundry api calls

servicesToCreate - services to create before pushing

manifestChoice - the manifest to use

Method Detail

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)

This is the main method, which gets called when the plugin must run as part of a build.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build -

launcher -

listener -

Returns:

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Gets the required monitor service (NONE).

Returns:

the required monitor service (NONE)

isResetIfExists

public boolean isResetIfExists()