com.compuware.jenkins.scm

Class EndevorConfiguration.EndevorDescriptorImpl

java.lang.Object

hudson.model.Descriptor<SCM>

hudson.scm.SCMDescriptor<EndevorConfiguration>

com.compuware.jenkins.scm.EndevorConfiguration.EndevorDescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

EndevorConfiguration

@Extension
public static class EndevorConfiguration.EndevorDescriptorImpl
extends SCMDescriptor<EndevorConfiguration>

DescriptorImpl is used to create instances of EndevorConfiguration. It also contains the global configuration options as fields, just like the EndevorConfiguration 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
EndevorDescriptorImpl() 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.
FormValidation	doCheckConnectionId(String connectionId) Validator for the 'Host connection' field.
FormValidation	doCheckCredentialsId(String value) Validator for the 'Login Credentials' field.
FormValidation	doCheckFileExtension(String value) Validator for the 'File extension to assign' text field.
FormValidation	doCheckFilterPattern(String value) Validator for the 'Filter pattern' 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 Credentials selection box with applicable Jenkins credentials.
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

EndevorDescriptorImpl

public EndevorDescriptorImpl()

Constructor.

Method Detail

isApplicable

public boolean isApplicable(Job project)

Necessary to display UI in Jenkins Pipeline.

Overrides:

isApplicable in class SCMDescriptor<EndevorConfiguration>

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 - if an error occurs submitting the form data

Descriptor.FormException

doCheckFilterPattern

public FormValidation doCheckFilterPattern(@QueryParameter
                                           String value)

Validator for the 'Filter pattern' text field.

Parameters:

value - value passed from the "filterPattern" field

Returns:

validation message

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

doCheckFileExtension

public FormValidation doCheckFileExtension(@QueryParameter
                                           String value)

Validator for the 'File extension to assign' text field.

Parameters:

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

Returns:

validation message

doCheckCredentialsId

public FormValidation doCheckCredentialsId(@QueryParameter
                                           String value)

Validator for the 'Login Credentials' field.

Parameters:

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

Returns:

validation message

doFillCredentialsIdItems

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

Fills in the Login Credentials selection box with applicable Jenkins credentials.

Parameters:

context - filter for credentials

credentialsId - existing login credentials; can be null

project - the Jenkins project

Returns:

credential selections