com.compuware.jenkins.totaltest

Class TotalTestBuilder.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

com.compuware.jenkins.totaltest.TotalTestBuilder.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable, jenkins.util.io.OnMaster

Enclosing class:

TotalTestBuilder

@Symbol(value="totaltestUT")
 @Extension
public static final class TotalTestBuilder.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Builder>

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

See src/main/resources/hudson/plugins/totatest/TotalTestRunner/*.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
DescriptorImpl() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) The method is called when the global configuration page is submitted.
hudson.util.FormValidation	doCheckCcRepo(String value) Validates the 'ccRepo' field.
hudson.util.FormValidation	doCheckCcSystem(String value) Validates the 'ccTestId' field.
hudson.util.FormValidation	doCheckCcTestId(String value) Validates the 'ccTestId' field.
hudson.util.FormValidation	doCheckCredentialsId(String value) Validates for the 'Login Credential' field
hudson.util.FormValidation	doCheckHlq(String value) Validates for the 'hlsq' field
hudson.util.FormValidation	doCheckHostPort(String value) Validates the 'hostPort' text field
hudson.util.FormValidation	doCheckJcl(String value) Validates for the 'JCL' text field
hudson.util.FormValidation	doCheckProjectFolder(String value) Validates the 'projectFolder' text field
hudson.util.FormValidation	doCheckTestSuite(String value) Validates the 'testSuite' text field
hudson.util.ListBoxModel	doFillCcPgmTypeItems(jenkins.model.Jenkins context, String ccPgmType, hudson.model.Item project) Fill in the Code Coverage program types.
hudson.util.ListBoxModel	doFillConnectionIdItems(jenkins.model.Jenkins context, String connectionId, hudson.model.Item project) Fills in the Host Connection selection box with applicable connections.
hudson.util.ListBoxModel	doFillCredentialsIdItems(jenkins.model.Jenkins context, String credentialsId, hudson.model.Item project) Fills in the Login Credential selection box with applicable Jenkins credentials
String	getDisplayName()
boolean	isApplicable(Class<? extends hudson.model.AbstractProject> aClass)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, 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, getRequiredGlobalConfigPagePermission, 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

DescriptorImpl

public DescriptorImpl()

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

Method Detail

doCheckHostPort

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

Validates the 'hostPort' text field

Parameters:

value - Value passed from the config.jelly "hostPort" field

Returns:

An instance of FormValidation containing the validation status.

doCheckProjectFolder

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

Validates the 'projectFolder' text field

Parameters:

value - Value passed from the config.jelly "projectFolder" field

Returns:

An instance of FormValidation containing the validation status.

doCheckTestSuite

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

Validates the 'testSuite' text field

Parameters:

value - Value passed from the config.jelly "testSuite" field

Returns:

An instance of FormValidation containing the validation status.

doCheckJcl

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

Validates for the 'JCL' text field

Parameters:

value - Value passed from the config.jelly "jcl" field

Returns:

An instance of FormValidation containing the validation status.

doCheckHlq

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

Validates for the 'hlsq' field

Parameters:

value - Value passed from the config.jelly "hlq" field

Returns:

An instance of FormValidation containing the validation status.

doCheckCcRepo

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

Validates the 'ccRepo' field.

Parameters:

value - Value passed from the config.jelly "ccRepo" field

Returns:

An instance of FormValidation containing the validation status.

doCheckCcSystem

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

Validates the 'ccTestId' field.

Parameters:

value - Value passed from the config.jelly "ccRepo" field

Returns:

An instance of FormValidation containing the validation status.

doCheckCcTestId

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

Validates the 'ccTestId' field.

Parameters:

value - Value passed from the config.jelly "ccRepo" field

Returns:

An instance of FormValidation containing the validation status.

doCheckCredentialsId

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

Validates for the 'Login Credential' field

Parameters:

value - Value passed from the config.jelly "fileExtension" field

Returns:

validation message

doFillConnectionIdItems

public hudson.util.ListBoxModel doFillConnectionIdItems(@AncestorInPath
                                                        jenkins.model.Jenkins context,
                                                        @QueryParameter
                                                        String connectionId,
                                                        @AncestorInPath
                                                        hudson.model.Item project)

Fills in the Host Connection selection box with applicable connections.

Parameters:

context - An instance of context for the Jenkin's context

connectionId - an existing host connection identifier; can be null

project - An instance of Item for the project.

Returns:

host connection selections

doFillCcPgmTypeItems

public hudson.util.ListBoxModel doFillCcPgmTypeItems(@AncestorInPath
                                                     jenkins.model.Jenkins context,
                                                     @QueryParameter
                                                     String ccPgmType,
                                                     @AncestorInPath
                                                     hudson.model.Item project)

Fill in the Code Coverage program types.

Parameters:

context - An instance of context for the Jenkin's context

ccPgmType - The type of program to test.

project - An instance of Item for the project.

Returns:

A ListBoxModel instance contain the Code Coverage program types.

doFillCredentialsIdItems

public hudson.util.ListBoxModel doFillCredentialsIdItems(@AncestorInPath
                                                         jenkins.model.Jenkins context,
                                                         @QueryParameter
                                                         String credentialsId,
                                                         @AncestorInPath
                                                         hudson.model.Item project)

Fills in the Login Credential selection box with applicable Jenkins credentials

Parameters:

context - An instance of context for the Jenkin's context

credentialsId - The credendtial id for the user.

project - An instance of Item for the project.

Returns:

credential selections

isApplicable

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

Specified by:

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

getDisplayName

public String getDisplayName()

Overrides:

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

configure

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

The method is called when the global configuration page is submitted. In the method the data in the web form should be copied to the Descriptor's fields. To persist the fields to the global configuration XML file, the save() method must be called. Data is defined in the global.jelly page.

Overrides:

configure in class hudson.model.Descriptor<hudson.tasks.Builder>

Parameters:

req - Stapler request

formData - Form data

Returns:

TRUE if able to configure and continue to next page

Throws:

FormException - If an error occurred processing configuration.

hudson.model.Descriptor.FormException