Class XygeniConfiguration

java.lang.Object
hudson.model.Descriptor<GlobalConfiguration>
jenkins.model.GlobalConfiguration
io.jenkins.plugins.xygeni.configuration.XygeniConfiguration
All Implemented Interfaces:
ExtensionPoint, Describable<GlobalConfiguration>, Saveable, OnMaster

@Extension public class XygeniConfiguration extends GlobalConfiguration
Global configuration of Xygeni Plugin.

Xygeni Plugin require Xygeni Api url (use cloud production by default), and a Xygeni Api Token generate by customer administrator to connect to Xygeni api.

Xygeni Api Token should be saved as credential secret at Jenkins instance and pass here as secret-id.

Author:
Victor de la Rosa
  • Constructor Details Link icon

    • XygeniConfiguration Link icon

      public XygeniConfiguration()
  • Method Details Link icon

    • get Link icon

      public static XygeniConfiguration get()
      Returns:
      the singleton instance
    • getVersion Link icon

      public String getVersion()
    • getXygeniTokenSecretId Link icon

      public String getXygeniTokenSecretId()
      Returns:
      the currently field value, if any
    • setXygeniTokenSecretId Link icon

      @DataBoundSetter public void setXygeniTokenSecretId(String xygeniTokenSecret)
      Together with getXygeniTokenSecretId(), binds to entry in config.jelly.
      Parameters:
      xygeniTokenSecret - the new value of this field
    • getXygeniUrl Link icon

      public String getXygeniUrl()
      Returns:
      the currently configured label, if any
    • setXygeniUrl Link icon

      @DataBoundSetter public void setXygeniUrl(String xygeniUrl)
      Together with getXygeniUrl(), binds to entry in config.jelly.
      Parameters:
      xygeniUrl - the new value of this field
    • doCheckXygeniToken Link icon

      public FormValidation doCheckXygeniToken(@QueryParameter String value)
      Check if field is not empty
      Parameters:
      value - form field value
      Returns:
      FormValidation ok if not empty or warning message
    • doCheckXygeniUrl Link icon

      public FormValidation doCheckXygeniUrl(@QueryParameter String value)
      Check if field is not empty
      Parameters:
      value - form field value
      Returns:
      FormValidation ok if not empty or warning message
    • doTestXygeniConnection Link icon

      public FormValidation doTestXygeniConnection(@QueryParameter("xygeniTokenSecretId") String xygeniTokenSecretIdField, @QueryParameter("xygeniUrl") String xygeniUrlField)
      Check if current configuration allow to connect to Xygeni platform.
      Parameters:
      xygeniTokenSecretIdField - tokenSecret field value
      xygeniUrlField - xygeniurl field value
      Returns:
      FormValidation ok if connect could be establish and token is valid
    • getXygeniToken Link icon

      public Secret getXygeniToken()
      Read token from credential and return a Secret
      Returns:
      a Secret
    • configure Link icon

      public boolean configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json) throws Descriptor.FormException
      Overrides:
      configure in class GlobalConfiguration
      Throws:
      Descriptor.FormException
    • save Link icon

      public void save()
      Specified by:
      save in interface Saveable
      Overrides:
      save in class Descriptor<GlobalConfiguration>
    • isEmitConfigEvents Link icon

      public boolean isEmitConfigEvents()
    • isEmitComputerEvents Link icon

      public boolean isEmitComputerEvents()
    • isEmitItemEvents Link icon

      public boolean isEmitItemEvents()
    • isEmitBuildEvents Link icon

      public boolean isEmitBuildEvents()
    • isEmitScmEvents Link icon

      public boolean isEmitScmEvents()