com.viltgroup.xcp.jenkins

Class XCPEnvironmentsConfig

java.lang.Object

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

jenkins.model.GlobalConfiguration

com.viltgroup.xcp.jenkins.XCPEnvironmentsConfig

All Implemented Interfaces:

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

@Extension
public class XCPEnvironmentsConfig
extends jenkins.model.GlobalConfiguration

Global configurations for the Documentum xCP Plugin

See src/main/resources/com/viltgroup/xcp/plugins/XCPEnvironmentsConfig/*.jelly for the actual HTML fragment for the configuration screen.

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

Modifier and Type	Field and Description
List<XcpEnvironmentInstance>	xcpEnvironmentInstances

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
XCPEnvironmentsConfig() In order to load the persisted global configuration, you have to call load() in the constructor.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.util.FormValidation	doCheckName(String name) Performs on-the-fly validation of the form field 'name'.
hudson.util.FormValidation	doCheckXcpDesignerPath(String xcpDesignerPath) Performs on-the-fly validation of the form field 'xcpDesignerPath'.
hudson.util.FormValidation	doCheckXmsToolsPath(String xmsToolsPath) Performs on-the-fly validation of the form field 'xmsToolsPath'.
static XCPEnvironmentsConfig	get()
XcpEnvironmentInstance	getById(String xcpEnvId)
String	getDisplayName()

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, 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

Field Detail

xcpEnvironmentInstances

public final List<XcpEnvironmentInstance> xcpEnvironmentInstances

Constructor Detail

XCPEnvironmentsConfig

public XCPEnvironmentsConfig()

In order to load the persisted global configuration, you have to call load() in the constructor.

Method Detail

get

public static XCPEnvironmentsConfig get()

getById

public XcpEnvironmentInstance getById(String xcpEnvId)

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class jenkins.model.GlobalConfiguration

configure

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

Overrides:

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

Throws:

hudson.model.Descriptor.FormException

doCheckName

public hudson.util.FormValidation doCheckName(@QueryParameter
                                              String name)

Performs on-the-fly validation of the form field 'name'.

Parameters:

name - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.

doCheckXcpDesignerPath

public hudson.util.FormValidation doCheckXcpDesignerPath(@QueryParameter
                                                         String xcpDesignerPath)

Performs on-the-fly validation of the form field 'xcpDesignerPath'.

Parameters:

xcpDesignerPath - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.

doCheckXmsToolsPath

public hudson.util.FormValidation doCheckXmsToolsPath(@QueryParameter
                                                      String xmsToolsPath)

Performs on-the-fly validation of the form field 'xmsToolsPath'.

Parameters:

xmsToolsPath - This parameter receives the value that the user has typed.

Returns:

Indicates the outcome of the validation. This is sent to the browser.