com.embotics.vlm.plugin

Class VCommanderConfig

java.lang.Object

hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

jenkins.model.GlobalConfiguration

com.embotics.vlm.plugin.VCommanderConfig

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<jenkins.model.GlobalConfiguration>, hudson.model.Saveable

@Extension
public final class VCommanderConfig
extends jenkins.model.GlobalConfiguration

Global configuration for the VCommander plug-in, Shown on the Jenkins Configure System page.

Author:

btarczali

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType, hudson.model.Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
VCommanderConfig() Constructor, initializes the fields from saved json data

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckAddress(String value) Called by jelly, to validate address field
hudson.util.FormValidation	doCheckCredentialsId(hudson.model.Item item, String address, String credentialsId) Called by jelly, to validate credential field
hudson.util.ListBoxModel	doFillCredentialsIdItems(hudson.model.Item item, String credentialsId, String address) Called by jelly, to populate credentials drop-down
hudson.util.FormValidation	doTestConnection(String address, String credentialsId, String orgName) Called by jelly, to validate credentials
String	getAddress()
String	getCredentialsId()
String	getOrgName()
static VCommanderClient	getVCommanderClient() Creates a vComamnder rest client based on the global configuration
void	setAddress(String address)
void	setCredentialsId(String credentialsId)
void	setOrgName(String orgName)
protected void	setvCommanderClient(VCommanderClient vCommanderClient) Inject a rest client Useful for unit testing

Methods inherited from class jenkins.model.GlobalConfiguration

all, getCategory, getDescriptor, getGlobalConfigPage

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, 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

VCommanderConfig

public VCommanderConfig()

Constructor, initializes the fields from saved json data

Method Detail

getVCommanderClient

public static VCommanderClient getVCommanderClient()
                                            throws VCommanderException

Creates a vComamnder rest client based on the global configuration

Returns:

VCommanderClient

Throws:

VCommanderException

setvCommanderClient

protected void setvCommanderClient(VCommanderClient vCommanderClient)

Inject a rest client Useful for unit testing

Parameters:

vCommanderClient - vCommadner rest client

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws hudson.model.Descriptor.FormException

Overrides:

configure in class hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

Throws:

hudson.model.Descriptor.FormException

doFillCredentialsIdItems

public hudson.util.ListBoxModel doFillCredentialsIdItems(@AncestorInPath
                                                         hudson.model.Item item,
                                                         @QueryParameter
                                                         String credentialsId,
                                                         @QueryParameter
                                                         String address)

Called by jelly, to populate credentials drop-down

doCheckAddress

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

Called by jelly, to validate address field

Throws:

IOException

javax.servlet.ServletException

doCheckCredentialsId

public hudson.util.FormValidation doCheckCredentialsId(@AncestorInPath
                                                       hudson.model.Item item,
                                                       @QueryParameter
                                                       String address,
                                                       @QueryParameter
                                                       String credentialsId)

Called by jelly, to validate credential field

doTestConnection

public hudson.util.FormValidation doTestConnection(@QueryParameter(value="address")
                                                   String address,
                                                   @QueryParameter(value="credentialsId")
                                                   String credentialsId,
                                                   @QueryParameter(value="orgName")
                                                   String orgName)
                                            throws IOException,
                                                   javax.servlet.ServletException

Called by jelly, to validate credentials

Throws:

IOException

javax.servlet.ServletException

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

getCredentialsId

public String getCredentialsId()

setCredentialsId

public void setCredentialsId(String credentialsId)

getOrgName

public String getOrgName()

setOrgName

public void setOrgName(String orgName)