com.google.jenkins.plugins.manage

Class AbstractCloudDeploymentDescriptor

java.lang.Object

hudson.model.Descriptor<AbstractCloudDeployment>

com.google.jenkins.plugins.manage.AbstractCloudDeploymentDescriptor

All Implemented Interfaces:

hudson.model.Saveable

Direct Known Subclasses:

CloudDeploymentDeleter.DescriptorImpl, TemplatedCloudDeployment.DescriptorImpl

public abstract class AbstractCloudDeploymentDescriptor
extends hudson.model.Descriptor<AbstractCloudDeployment>

Descriptor from which CloudDeployment extensions must derive their descriptor.

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.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCloudDeploymentDescriptor(Class<? extends AbstractCloudDeployment> clazz) Boilerplate, see: https://wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point
protected	AbstractCloudDeploymentDescriptor(Class<? extends AbstractCloudDeployment> clazz, CloudDeploymentModule module) Create the descriptor of the cloud deployment from it's type on associated module for instantiating dependencies.

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
hudson.util.FormValidation	doCheckConfigFilePath(String configFilePath, hudson.model.AbstractProject project) This callback validates the configFilePath specified by the user.
hudson.util.FormValidation	doCheckDeploymentName(String deploymentName, hudson.model.AbstractProject project) This callback validates the deploymentName specified by the user.
CloudDeploymentModule	getModule() Retrieve the module to use for instantiating dependencies for instances described by this descriptor.
String	getRootUrl() Retrieve the root URL that should be used for Google Deployment Manager API calls.
String	getServicePath() Retrieve the service path that should be used for Google Deployment Manager API calls.
abstract boolean	isApplicable(hudson.model.Descriptor descriptor) Determines whether the given cloud deployment is suitable for use with a particular class of extensions.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, 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

AbstractCloudDeploymentDescriptor

protected AbstractCloudDeploymentDescriptor(Class<? extends AbstractCloudDeployment> clazz,
                                            CloudDeploymentModule module)

Create the descriptor of the cloud deployment from it's type on associated module for instantiating dependencies.

AbstractCloudDeploymentDescriptor

protected AbstractCloudDeploymentDescriptor(Class<? extends AbstractCloudDeployment> clazz)

Boilerplate, see: https://wiki.jenkins-ci.org/display/JENKINS/Defining+a+new+extension+point

Method Detail

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

Throws:

hudson.model.Descriptor.FormException

getRootUrl

public String getRootUrl()

Retrieve the root URL that should be used for Google Deployment Manager API calls.

getServicePath

public String getServicePath()

Retrieve the service path that should be used for Google Deployment Manager API calls.

isApplicable

public abstract boolean isApplicable(hudson.model.Descriptor descriptor)

Determines whether the given cloud deployment is suitable for use with a particular class of extensions.

For instance, some may be designed for use with a Cloud, while others may be designed for use with a Publisher.

getModule

public CloudDeploymentModule getModule()

Retrieve the module to use for instantiating dependencies for instances described by this descriptor.

doCheckConfigFilePath

public hudson.util.FormValidation doCheckConfigFilePath(@QueryParameter(value="configFilePath")
                                                        String configFilePath,
                                                        @AncestorInPath
                                                        hudson.model.AbstractProject project)
                                                 throws IOException

This callback validates the configFilePath specified by the user.

Throws:

IOException

doCheckDeploymentName

public hudson.util.FormValidation doCheckDeploymentName(@QueryParameter(value="deploymentName")
                                                        String deploymentName,
                                                        @AncestorInPath
                                                        hudson.model.AbstractProject project)
                                                 throws IOException

This callback validates the deploymentName specified by the user.

Throws:

IOException