com.ibm.devops.dra

Class EvaluateGate.EvaluateGateImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

com.ibm.devops.dra.EvaluateGate.EvaluateGateImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

EvaluateGate

@Extension
public static final class EvaluateGate.EvaluateGateImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

Descriptor for EvaluateGate. Used as a singleton. The class is marked as public so that it can be accessed from views.

See src/main/resources/hudson/plugins/hello_world/HelloWorldBuilder/*.jelly for the actual HTML fragment for the configuration screen.

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 inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
EvaluateGateImpl() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method and Description
hudson.model.AutoCompletionCandidates	doAutoCompleteBuildJobName(String value) Autocompletion for build job name field
hudson.util.FormValidation	doCheckApplicationName(String value) Performs on-the-fly validation of the form field 'name'.
hudson.util.FormValidation	doCheckEnvironmentName(String value)
hudson.util.FormValidation	doCheckPolicyName(String value)
hudson.util.FormValidation	doCheckToolchainName(String value)
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.ListBoxModel	doFillPolicyNameItems(hudson.model.ItemGroup context, String toolchainName, String credentialsId) This method is called to populate the policy list on the Jenkins config page.
hudson.util.FormValidation	doTestConnection(hudson.model.ItemGroup context, String credentialsId)
String	getDisplayName() Required Method
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass) Required Method This is used to determine if this build step is applicable for your chosen project type.
boolean	isDebugMode()

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

Constructor Detail

EvaluateGateImpl

public EvaluateGateImpl()

In order to load the persisted global configuration, you have to call load() in the constructor.

Method Detail

doCheckApplicationName

public hudson.util.FormValidation doCheckApplicationName(@QueryParameter
                                                         String value)
                                                  throws IOException,
                                                         javax.servlet.ServletException

Performs on-the-fly validation of the form field 'name'.

Parameters:

value - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.

Note that returning FormValidation.error(String) does not prevent the form from being saved. It just means that a message will be displayed to the user.

Throws:

IOException

javax.servlet.ServletException

doCheckEnvironmentName

public hudson.util.FormValidation doCheckEnvironmentName(@QueryParameter
                                                         String value)
                                                  throws IOException,
                                                         javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

doCheckToolchainName

public hudson.util.FormValidation doCheckToolchainName(@QueryParameter
                                                       String value)
                                                throws IOException,
                                                       javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

doCheckPolicyName

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

doTestConnection

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

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.

doAutoCompleteBuildJobName

public hudson.model.AutoCompletionCandidates doAutoCompleteBuildJobName(@QueryParameter
                                                                        String value)

Autocompletion for build job name field

Parameters:

value -

Returns:

doFillPolicyNameItems

public hudson.util.ListBoxModel doFillPolicyNameItems(@AncestorInPath
                                                      hudson.model.ItemGroup context,
                                                      @QueryParameter
                                                      String toolchainName,
                                                      @QueryParameter
                                                      String credentialsId)

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

Parameters:

context -

credentialsId -

Returns:

isApplicable

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

Required Method This is used to determine if this build step is applicable for your chosen project type. (FreeStyle, MultiConfiguration, Maven) Some plugin build steps might be made to be only available to MultiConfiguration projects.

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

Parameters:

aClass - The current project

Returns:

a boolean indicating whether this build step can be chose given the project type

getDisplayName

public String getDisplayName()

Required Method

Overrides:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Publisher>

Returns:

The text to be displayed when selecting your build in the project

isDebugMode

public boolean isDebugMode()