com.compuware.jenkins.scm

Class PdsConfiguration.PdsDescriptorImpl

java.lang.Object

hudson.model.Descriptor<hudson.scm.SCM>

hudson.scm.SCMDescriptor<PdsConfiguration>

com.compuware.jenkins.scm.PdsConfiguration.PdsDescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

PdsConfiguration

@Extension
public static class PdsConfiguration.PdsDescriptorImpl
extends hudson.scm.SCMDescriptor<PdsConfiguration>

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

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.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
PdsDescriptorImpl() 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	doCheckCredentialsId(String value) Validator for the 'Login Credentials' field.
hudson.util.FormValidation	doCheckFileExtension(String value) Validator for the 'File extension to assign' text field.
hudson.util.FormValidation	doCheckFilterPattern(String value) Validator for the 'Filter pattern' text field.
hudson.util.FormValidation	doCheckHostPort(String value) Validator for the 'Host:port' text field.
hudson.util.ListBoxModel	doFillCodePageItems() Fills in the Code page selection box with code pages.
hudson.util.ListBoxModel	doFillCredentialsIdItems(jenkins.model.Jenkins context, String credentialsId, hudson.model.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(hudson.model.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, 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

PdsDescriptorImpl

public PdsDescriptorImpl()

Constructor.

Method Detail

isApplicable

public boolean isApplicable(hudson.model.Job project)

Necessary to display UI in Jenkins Pipeline.

Overrides:

isApplicable in class hudson.scm.SCMDescriptor<PdsConfiguration>

getDisplayName

public String getDisplayName()

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

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.scm.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 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.scm.SCM>

Parameters:

req - Stapler request

formData - Form data

Returns:

true if able to configure and continue to next page

Throws:

FormException

hudson.model.Descriptor.FormException

doCheckFilterPattern

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

Validator for the 'Filter pattern' text field.

Parameters:

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

Returns:

validation message

Throws:

IOException

javax.servlet.ServletException

doCheckHostPort

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

Validator for the 'Host:port' text field.

Parameters:

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

Returns:

validation message

Throws:

IOException

javax.servlet.ServletException

doCheckFileExtension

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

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

Parameters:

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

Returns:

validation message

Throws:

IOException

javax.servlet.ServletException

doCheckCredentialsId

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

Validator for the 'Login Credentials' field.

Parameters:

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

Returns:

validation message

Throws:

IOException

javax.servlet.ServletException

doFillCredentialsIdItems

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

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

Parameters:

context - filter for credentials

Returns:

credential selections

Throws:

IOException

javax.servlet.ServletException

doFillCodePageItems

public hudson.util.ListBoxModel doFillCodePageItems()
                                             throws IOException,
                                                    javax.servlet.ServletException

Fills in the Code page selection box with code pages.

Returns:

code page selections

Throws:

IOException

javax.servlet.ServletException