Package org.jenkinsci.plugins.vmanager

Class VMGRLaunch.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Builder>

org.jenkinsci.plugins.vmanager.VMGRLaunch.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

VMGRLaunch

@Extension
public static final class VMGRLaunch.DescriptorImpl
extends BuildStepDescriptor<Builder>

Descriptor for VMGRLaunch. 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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
DescriptorImpl()	To persist global configuration information, simply store it in a field and call save().

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)
FormValidation	doCheckStaticAttributeList(String value)
FormValidation	doCheckVAPICredentials(Item item, String value)
FormValidation	doCheckVAPIUrl(String value)	Performs on-the-fly validation of the form field 'name'.
ListBoxModel	doFillDoneResolverItems()
ListBoxModel	doFillEnvSourceInputFileTypeItems()
ListBoxModel	doFillFailedResolverItems()
ListBoxModel	doFillInaccessibleResolverItems()
ListBoxModel	doFillStoppedResolverItems()
ListBoxModel	doFillSuspendedResolverItems()
ListBoxModel	doFillVAPICredentialsItems(Item item, String vAPICredentials)
FormValidation	doTestArchiveUser(String archiveUser, Secret archivePassword, String vAPIUrl, Item item)
FormValidation	doTestConnection(String vAPIUser, Secret vAPIPassword, String vAPIUrl, boolean authRequired, String credentialType, String vAPICredentials, Item item)
FormValidation	doTestExtraStaticAttr(String vAPIUser, Secret vAPIPassword, String vAPIUrl, boolean authRequired, String staticAttributeList, String credentialType, String vAPICredentials, Item item)
String	getDisplayName()	This human readable name is used in the configuration screen.
boolean	isApplicable(Class<? extends AbstractProject> aClass)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, 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, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

DescriptorImpl

public DescriptorImpl()

To persist global configuration information, simply store it in a field and call save(). /** In order to load the persisted global configuration, you have to call load() in the constructor.

Method Details

doCheckVAPIUrl

public FormValidation doCheckVAPIUrl(@QueryParameter
 String value)
                              throws IOException,
jakarta.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

jakarta.servlet.ServletException

doCheckStaticAttributeList

public FormValidation doCheckStaticAttributeList(@QueryParameter
 String value)
                                          throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

isApplicable

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

Specified by:

isApplicable in class BuildStepDescriptor<Builder>

doFillInaccessibleResolverItems

public ListBoxModel doFillInaccessibleResolverItems()

doFillEnvSourceInputFileTypeItems

public ListBoxModel doFillEnvSourceInputFileTypeItems()

doFillStoppedResolverItems

public ListBoxModel doFillStoppedResolverItems()

doFillFailedResolverItems

public ListBoxModel doFillFailedResolverItems()

doFillDoneResolverItems

public ListBoxModel doFillDoneResolverItems()

doFillSuspendedResolverItems

public ListBoxModel doFillSuspendedResolverItems()

doFillVAPICredentialsItems

public ListBoxModel doFillVAPICredentialsItems(@AncestorInPath
 Item item,
 @QueryParameter
 String vAPICredentials)

getDisplayName

public String getDisplayName()

This human readable name is used in the configuration screen.

Overrides:

getDisplayName in class Descriptor<Builder>

configure

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

Overrides:

configure in class Descriptor<Builder>

Throws:

Descriptor.FormException

doTestConnection

@POST
public FormValidation doTestConnection(@QueryParameter("vAPIUser")
 String vAPIUser,
 @QueryParameter("vAPIPassword")
 Secret vAPIPassword,
 @QueryParameter("vAPIUrl")
 String vAPIUrl,
 @QueryParameter("authRequired")
 boolean authRequired,
 @QueryParameter("credentialType")
 String credentialType,
 @QueryParameter("vAPICredentials")
 String vAPICredentials,
 @AncestorInPath
 Item item)
                                throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doTestArchiveUser

@POST
public FormValidation doTestArchiveUser(@QueryParameter("archiveUser")
 String archiveUser,
 @QueryParameter("archivePassword")
 Secret archivePassword,
 @QueryParameter("vAPIUrl")
 String vAPIUrl,
 @AncestorInPath
 Item item)
                                 throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doTestExtraStaticAttr

@POST
public FormValidation doTestExtraStaticAttr(@QueryParameter("vAPIUser")
 String vAPIUser,
 @QueryParameter("vAPIPassword")
 Secret vAPIPassword,
 @QueryParameter("vAPIUrl")
 String vAPIUrl,
 @QueryParameter("authRequired")
 boolean authRequired,
 @QueryParameter("staticAttributeList")
 String staticAttributeList,
 @QueryParameter("credentialType")
 String credentialType,
 @QueryParameter("vAPICredentials")
 String vAPICredentials,
 @AncestorInPath
 Item item)
                                     throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

doCheckVAPICredentials

public FormValidation doCheckVAPICredentials(@AncestorInPath
 Item item,
 @QueryParameter
 String value)