com.openshift.jenkins.plugins.pipeline

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

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<T>

com.openshift.jenkins.plugins.pipeline.TimedBuildStepDescriptor<T>

All Implemented Interfaces:

IOpenShiftParameterOverrides, IOpenShiftPluginDescriptor, hudson.model.Saveable

Direct Known Subclasses:

OpenShiftBuilder.DescriptorImpl, OpenShiftBuildVerifier.DescriptorImpl, OpenShiftDeployer.DescriptorImpl, OpenShiftDeploymentVerifier.DescriptorImpl, OpenShiftExec.DescriptorImpl, OpenShiftScaler.DescriptorImpl, OpenShiftScalerPostAction.DescriptorImpl

public abstract class TimedBuildStepDescriptor<T extends hudson.tasks.BuildStep & hudson.model.Describable<T>>
extends hudson.tasks.BuildStepDescriptor<T>
implements IOpenShiftPluginDescriptor

Extending this descriptor imbues subclasses with a global Jenkins timeout setting. Theory of operation: 1. Each timed operation which exposes a global timeout extends this descriptor. 2. The descriptor will persist/restore a global wait/waitUnit for the operation type. 3. Classes wishing to share the same timeout value (e.g. DSL steps) should access the timeout value through GlobalConfig. 4. GlobalConfig will load the correct descriptor to read the currently configured timeout value. 5. The host for the global config option must have a global.jelly for setting the value from Jenkins Configure. See examples like: src/main/resources/com/openshift/jenkins/plugins/pipeline/OpenShiftExec /global.jelly

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
protected String	wait
protected String	waitUnit

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftPluginDescriptor

LOGGER

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
TimedBuildStepDescriptor()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
long	getConfiguredDefaultWaitTime()
protected abstract long	getStaticDefaultWaitTime()
String	getWait()
String	getWaitUnit()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass)
void	load()

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, 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

Methods inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftPluginDescriptor

buildEnvVars, doCheckApiURL, doCheckAuthToken, doCheckNamespace, doCheckWaitTime, doFillWaitUnitItems, doTestConnection

Methods inherited from interface com.openshift.jenkins.plugins.pipeline.model.IOpenShiftParameterOverrides

getOverride, pruneKey

Field Detail

wait

protected String wait

waitUnit

protected String waitUnit

Constructor Detail

TimedBuildStepDescriptor

TimedBuildStepDescriptor()

Method Detail

load

public void load()

Overrides:

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

isApplicable

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

Specified by:

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

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws hudson.model.Descriptor.FormException

Overrides:

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

Throws:

hudson.model.Descriptor.FormException

getConfiguredDefaultWaitTime

public long getConfiguredDefaultWaitTime()

getWait

public String getWait()

getWaitUnit

public String getWaitUnit()

getStaticDefaultWaitTime

protected abstract long getStaticDefaultWaitTime()

Returns:

Return the non-configurable default for this build step. This will populate the global default wait time for the operation the first time Jenkins loads this plugin. Once a global configuration with a value exists, this value will no longer be used. However, this value will be re-populated if the user clears the global timeout form and saves the configuration.