Package org.jenkinsci.plugins.vmanager

Class VMGRAPI.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Builder>

org.jenkinsci.plugins.vmanager.VMGRAPI.DescriptorImpl

All Implemented Interfaces:

Saveable, Loadable, OnMaster

Enclosing class:

VMGRAPI

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

Descriptor for VMGRAPI. 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()	In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method	Description
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)
FormValidation	doCheckApiUrl(String value)
FormValidation	doCheckRequestMethod(String value)
FormValidation	doCheckVAPIUrl(String value)	Performs on-the-fly validation of the form field 'name'.
ListBoxModel	doFillRequestMethodItems()
FormValidation	doTestConnection(String vAPIUser, Secret vAPIPassword, String vAPIUrl, boolean authRequired, 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()

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

doCheckApiUrl

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

Throws:

IOException

jakarta.servlet.ServletException

doCheckRequestMethod

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

Throws:

IOException

jakarta.servlet.ServletException

doFillRequestMethodItems

public ListBoxModel doFillRequestMethodItems()

isApplicable

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

Specified by:

isApplicable in class BuildStepDescriptor<Builder>

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,
 @AncestorInPath
 Item item)
                                throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException