Package hudson.plugins.octopusdeploy

Class OctopusDeployPlugin.DescriptorImpl

  • All Implemented Interfaces:
    hudson.model.Saveable, jenkins.util.io.OnMaster
    Enclosing class:
    OctopusDeployPlugin
    @Extension
@Symbol("octopusGlobalConfiguration")
public static final class OctopusDeployPlugin.DescriptorImpl
extends hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

    • 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 
      Constructor Description
      DescriptorImpl()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean configure​(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)  
      hudson.util.FormValidation doCheckApiKey​(java.lang.String apiKey)
      Validate that the apiKey is: - Not empty - has a valid OctopusDeploy API Key format: API-XXXXXXXXX
      hudson.util.FormValidation doCheckServerId​(java.lang.String serverId, java.lang.String url, java.lang.String apiKey)
      Validate that serverId is: - Not empty - Unique
      hudson.util.FormValidation doCheckUrl​(java.lang.String url)
      Validate that the host is: - Not empty - A well formed URL - A real location that we can connect to
      OctopusDeployServer getDefaultOctopusDeployServer()
      Get the default OctopusDeployServer instance
      java.lang.String getDisplayName()  
      java.util.List<OctopusDeployServer> getOctopusDeployServers()  
      void setOctopusDeployServers​(java.util.List<OctopusDeployServer> servers)  

      • Methods inherited from class hudson.model.Descriptor

        addHelpFileRedirect, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, 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, 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

      • DescriptorImpl

        public DescriptorImpl()

    • Method Detail

      • getDefaultOctopusDeployServer

        public OctopusDeployServer getDefaultOctopusDeployServer()
        Get the default OctopusDeployServer instance
        Returns:
        the default server

      • getOctopusDeployServers

        public java.util.List<OctopusDeployServer> getOctopusDeployServers()

      • setOctopusDeployServers

        @DataBoundSetter
public void setOctopusDeployServers​(java.util.List<OctopusDeployServer> servers)

      • getDisplayName

        public java.lang.String getDisplayName()
        Overrides:
        getDisplayName in class hudson.model.Descriptor<jenkins.model.GlobalConfiguration>

      • doCheckServerId

        public hudson.util.FormValidation doCheckServerId​(@QueryParameter
                                                  java.lang.String serverId,
                                                  @QueryParameter
                                                  java.lang.String url,
                                                  @QueryParameter
                                                  java.lang.String apiKey)
        Validate that serverId is: - Not empty - Unique
        Parameters:
        serverId - the uniqueId for an Octopus Deploy instance
        url - the url of the Octopus Deploy server
        apiKey - the api key of the Octopus Deploy server
        Returns:
        Form validation to present on the Jenkins UI

      • doCheckUrl

        public hudson.util.FormValidation doCheckUrl​(@QueryParameter
                                             java.lang.String url)
        Validate that the host is: - Not empty - A well formed URL - A real location that we can connect to
        Parameters:
        url - the host URL for the octopus deploy instance
        Returns:
        Form validation to present on the Jenkins UI

      • doCheckApiKey

        public hudson.util.FormValidation doCheckApiKey​(@QueryParameter
                                                java.lang.String apiKey)
        Validate that the apiKey is: - Not empty - has a valid OctopusDeploy API Key format: API-XXXXXXXXX
        Parameters:
        apiKey - Octopus API Key used for deployment
        Returns:
        Form validation to present on the Jenkins UI

      • 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