com.hpe.cloudfoundryjenkins

Class AbstractCloudFoundryPushDescriptor<T extends hudson.tasks.BuildStep & hudson.model.Describable<T>>

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<T>

com.hpe.cloudfoundryjenkins.AbstractCloudFoundryPushDescriptor<T>

Type Parameters:

T - the build step type

All Implemented Interfaces:

hudson.model.Saveable

Direct Known Subclasses:

CloudFoundryPushBuilder.DescriptorImpl, CloudFoundryPushPublisher.DescriptorImpl

public abstract class AbstractCloudFoundryPushDescriptor<T extends hudson.tasks.BuildStep & hudson.model.Describable<T>>
extends hudson.tasks.BuildStepDescriptor<T>

Extension point descriptor for cloudfoundry push.

Author:

williamg, Steven Swor

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INSTANCES Default number of instances to deploy (1).
static int	DEFAULT_MEMORY Default memory to allocate (512mb)
static String	DEFAULT_STACK Default stack of the target.
static int	DEFAULT_TIMEOUT Default application startup timeout (60 seconds).

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloudFoundryPushDescriptor() Creates a new descriptor.
protected	AbstractCloudFoundryPushDescriptor(Class<? extends T> clazz) Creates a new descriptor.

Method Summary

Modifier and Type	Method and Description
hudson.util.FormValidation	doCheckAppName(String value) Marks the app name as a required parameter
hudson.util.FormValidation	doCheckCloudSpace(String value) Marks the cloud space as a required parameter
hudson.util.FormValidation	doCheckCredentialsId(String value) Marks credentials as a required parameter
hudson.util.FormValidation	doCheckHostname(String value) Marks the hostname as a required parameter
hudson.util.FormValidation	doCheckInstances(String value) Marks the number of instances as a required positive integer
hudson.util.FormValidation	doCheckMemory(String value) Marks the memory allocation as a required positive integer
hudson.util.FormValidation	doCheckOrganization(String value) Marks the organization as a required parameter
hudson.util.FormValidation	doCheckPluginTimeout(String value) Marks the plugin timeout as a required positive integer
hudson.util.FormValidation	doCheckTarget(String value) Verifies the URL format of the cloudfoundry target
hudson.util.FormValidation	doCheckTimeout(String value) Marks the application timeout as a required positive integer
hudson.util.ListBoxModel	doFillCredentialsIdItems(hudson.model.ItemGroup context, String target) This method is called to populate the credentials list on the Jenkins config page.
hudson.util.FormValidation	doTestConnection(hudson.model.ItemGroup context, String target, String credentialsId, String organization, String cloudSpace, boolean selfSigned) This method is called when the "Test Connection" button is clicked on the Jenkins config page.
String	getDisplayName()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> jobType)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MEMORY

public static final int DEFAULT_MEMORY

Default memory to allocate (512mb)

See Also:

Constant Field Values

DEFAULT_INSTANCES

public static final int DEFAULT_INSTANCES

Default number of instances to deploy (1).

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Default application startup timeout (60 seconds).

See Also:

Constant Field Values

DEFAULT_STACK

public static final String DEFAULT_STACK

Default stack of the target.

Constructor Detail

AbstractCloudFoundryPushDescriptor

protected AbstractCloudFoundryPushDescriptor(Class<? extends T> clazz)

Creates a new descriptor.

Parameters:

clazz - the specific class being described

AbstractCloudFoundryPushDescriptor

protected AbstractCloudFoundryPushDescriptor()

Creates a new descriptor.

Method Detail

isApplicable

public boolean isApplicable(Class<? extends hudson.model.AbstractProject> jobType)

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<T extends hudson.tasks.BuildStep & hudson.model.Describable<T>>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<T extends hudson.tasks.BuildStep & hudson.model.Describable<T>>

doFillCredentialsIdItems

public hudson.util.ListBoxModel doFillCredentialsIdItems(@AncestorInPath
                                                         hudson.model.ItemGroup context,
                                                         @QueryParameter(value="target")
                                                         String target)

This method is called to populate the credentials list on the Jenkins config page.

Parameters:

context - the context

target - the target

Returns:

the credentials list box model

doTestConnection

public hudson.util.FormValidation doTestConnection(@AncestorInPath
                                                   hudson.model.ItemGroup context,
                                                   @QueryParameter(value="target")
                                                   String target,
                                                   @QueryParameter(value="credentialsId")
                                                   String credentialsId,
                                                   @QueryParameter(value="organization")
                                                   String organization,
                                                   @QueryParameter(value="cloudSpace")
                                                   String cloudSpace,
                                                   @QueryParameter(value="selfSigned")
                                                   boolean selfSigned)

This method is called when the "Test Connection" button is clicked on the Jenkins config page.

Parameters:

context - the context

target - the cloudfoundry target

credentialsId - the ID of the jenkins credentials to use

organization - the cloudfoundry organization

cloudSpace - the cloudfoundry space

selfSigned - true to ignore ssl validation errors

Returns:

the validation result

doCheckTarget

public hudson.util.FormValidation doCheckTarget(@QueryParameter
                                                String value)

Verifies the URL format of the cloudfoundry target

Parameters:

value - the value to check

Returns:

the validation result

doCheckCredentialsId

public hudson.util.FormValidation doCheckCredentialsId(@QueryParameter
                                                       String value)

Marks credentials as a required parameter

Parameters:

value - the value

Returns:

the validation

doCheckOrganization

public hudson.util.FormValidation doCheckOrganization(@QueryParameter
                                                      String value)

Marks the organization as a required parameter

Parameters:

value - the value

Returns:

the validation

doCheckCloudSpace

public hudson.util.FormValidation doCheckCloudSpace(@QueryParameter
                                                    String value)

Marks the cloud space as a required parameter

Parameters:

value - the value

Returns:

the validation

doCheckPluginTimeout

public hudson.util.FormValidation doCheckPluginTimeout(@QueryParameter
                                                       String value)

Marks the plugin timeout as a required positive integer

Parameters:

value - the value

Returns:

the validation

doCheckMemory

public hudson.util.FormValidation doCheckMemory(@QueryParameter
                                                String value)

Marks the memory allocation as a required positive integer

Parameters:

value - the value

Returns:

the validation

doCheckInstances

public hudson.util.FormValidation doCheckInstances(@QueryParameter
                                                   String value)

Marks the number of instances as a required positive integer

Parameters:

value - the value

Returns:

the validation

doCheckTimeout

public hudson.util.FormValidation doCheckTimeout(@QueryParameter
                                                 String value)

Marks the application timeout as a required positive integer

Parameters:

value - the value

Returns:

the validation

doCheckAppName

public hudson.util.FormValidation doCheckAppName(@QueryParameter
                                                 String value)

Marks the app name as a required parameter

Parameters:

value - the value

Returns:

the validation

doCheckHostname

public hudson.util.FormValidation doCheckHostname(@QueryParameter
                                                  String value)

Marks the hostname as a required parameter

Parameters:

value - the value

Returns:

the validation