com.compuware.jenkins.scm

Class IspwConfiguration.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<SCM>

hudson.scm.SCMDescriptor<IspwConfiguration>

com.compuware.jenkins.scm.IspwConfiguration.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

IspwConfiguration

@Extension
public static class IspwConfiguration.DescriptorImpl
extends SCMDescriptor<IspwConfiguration>

DescriptorImpl is used to create instances of IspwConfiguration. It also contains the global configuration options as fields, just like the IspwConfiguration contains the configuration options for a job

Nested Class Summary

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.scm.SCMDescriptor

generation, repositoryBrowser

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DescriptorImpl()

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.
FormValidation	doCheckConnectionId(String connectionId) Validator for the 'Host connection' field.
FormValidation	doCheckCredentialsId(String value) Validator for the 'Login Credential' field
FormValidation	doCheckServerApplication(String value) Validator for the 'Application' text field.
FormValidation	doCheckServerLevel(String value) Validator for the 'Level' text field.
FormValidation	doCheckServerStream(String value) Validator for the 'Stream' text field.
ListBoxModel	doFillConnectionIdItems(Jenkins context, String connectionId, Item project) Fills in the Host Connection selection box with applicable connections.
ListBoxModel	doFillCredentialsIdItems(Jenkins context, String credentialsId, Item project) Fills in the Login Credential selection box with applicable Jenkins credentials
ListBoxModel	doFillLevelOptionItems() Fills in the Level option selection box with ISPW level options
String	getDisplayName() Displays the name of the SCM, the name that appears when configuring a Jenkins job.
boolean	isApplicable(Job project) Necessary to display UI in Jenkins Pipeline.

Methods inherited from class hudson.scm.SCMDescriptor

getBrowserDescriptors, isApplicable, isBrowserReusable, load

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

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Method Detail

isApplicable

public boolean isApplicable(Job project)

Necessary to display UI in Jenkins Pipeline.

Overrides:

isApplicable in class SCMDescriptor<IspwConfiguration>

getDisplayName

public String getDisplayName()

Displays the name of the SCM, the name that appears when configuring a Jenkins job.

Overrides:

getDisplayName in class Descriptor<SCM>

Returns:

the String value of the SCM display name

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)
                  throws 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 Descriptor<SCM>

Parameters:

req - Stapler request

formData - Form data

Returns:

TRUE if able to configure and continue to next page

Throws:

FormException

Descriptor.FormException

doCheckConnectionId

public FormValidation doCheckConnectionId(@QueryParameter
                                          String connectionId)

Validator for the 'Host connection' field.

Parameters:

connectionId - unique identifier for the host connection passed from the config.jelly "connectionId" field

Returns:

validation message

doFillConnectionIdItems

public ListBoxModel doFillConnectionIdItems(@AncestorInPath
                                            Jenkins context,
                                            @QueryParameter
                                            String connectionId,
                                            @AncestorInPath
                                            Item project)

Fills in the Host Connection selection box with applicable connections.

Parameters:

context - filter for host connections

connectionId - an existing host connection identifier; can be null

project - the Jenkins project

Returns:

host connection selections

doCheckCredentialsId

public FormValidation doCheckCredentialsId(@QueryParameter
                                           String value)

Validator for the 'Login Credential' field

Parameters:

value - value passed from the config.jelly "loginCredential" field

Returns:

validation message

doCheckServerStream

public FormValidation doCheckServerStream(@QueryParameter
                                          String value)

Validator for the 'Stream' text field.

Parameters:

value - value passed from the "serverStream" field

Returns:

validation message

doCheckServerApplication

public FormValidation doCheckServerApplication(@QueryParameter
                                               String value)

Validator for the 'Application' text field.

Parameters:

value - value passed from the "serverApplication" field

Returns:

validation message

doCheckServerLevel

public FormValidation doCheckServerLevel(@QueryParameter
                                         String value)

Validator for the 'Level' text field.

Parameters:

value - value passed from the "serverLevel" field

Returns:

validation message

doFillCredentialsIdItems

public ListBoxModel doFillCredentialsIdItems(@AncestorInPath
                                             Jenkins context,
                                             @QueryParameter
                                             String credentialsId,
                                             @AncestorInPath
                                             Item project)

Fills in the Login Credential selection box with applicable Jenkins credentials

Parameters:

context - filter for credentials

Returns:

credential selections

doFillLevelOptionItems

public ListBoxModel doFillLevelOptionItems()

Fills in the Level option selection box with ISPW level options

Returns:

level option selections