Package org.jenkinsci.plugins.envinject

Class EnvInjectPluginConfiguration

java.lang.Object
hudson.model.Descriptor<GlobalConfiguration>
jenkins.model.GlobalConfiguration
org.jenkinsci.plugins.envinject.EnvInjectPluginConfiguration
All Implemented Interfaces:
ExtensionPoint, Describable<GlobalConfiguration>, Saveable, Loadable, OnMaster
@Extension @Symbol("envInject") public class EnvInjectPluginConfiguration extends GlobalConfiguration
Configuration of security options for EnvInjectPlugin.
Since:
1.92
Author:
Oleg Nenashev

  • Constructor Details

    • EnvInjectPluginConfiguration

      @DataBoundConstructor public EnvInjectPluginConfiguration()

    • EnvInjectPluginConfiguration

      @Deprecated public EnvInjectPluginConfiguration(boolean hideInjectedVars, boolean enablePermissions)
      Deprecated.
      Use EnvInjectPluginConfiguration(boolean, boolean, boolean)
      Since:
      2.0 Loading of files from controller is disabled by default

  • Method Details

    • isHideInjectedVars

      public boolean isHideInjectedVars()

    • setHideInjectedVars

      @DataBoundSetter public void setHideInjectedVars(boolean hideInjectedVars)

    • isEnablePermissions

      public boolean isEnablePermissions()

    • setEnablePermissions

      @DataBoundSetter public void setEnablePermissions(boolean enabledPermissions)

    • isEnableLoadingFromMaster

      public boolean isEnableLoadingFromMaster()
      Check if the instance supports loading of scripts and property files from the controller. It does not prevent local loading of files.
      Returns:
      true if it is enabled
      Since:
      2.0
      See Also:
      • EnvInjectJobPropertyInfo.loadFilesFromMaster

    • setEnableLoadingFromMaster

      @DataBoundSetter public void setEnableLoadingFromMaster(boolean enableLoadingFromMaster)

    • getDefault

      @NonNull public static final EnvInjectPluginConfiguration getDefault()
      Gets the default configuration of EnvInjectPlugin
      Returns:
      Default configuration

    • getConfigFile

      protected XmlFile getConfigFile()
      Overrides:
      getConfigFile in class Descriptor<GlobalConfiguration>

    • configure

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

    • getInstance

      @CheckForNull public static EnvInjectPluginConfiguration getInstance()

    • getOrFail

      @NonNull public static EnvInjectPluginConfiguration getOrFail() throws org.jenkinsci.lib.envinject.EnvInjectException
      Retrieves the EnvInject global configuration.
      Returns:
      Settings
      Throws:
      org.jenkinsci.lib.envinject.EnvInjectException - The configuration cannot be retrieved

    • getCategory

      public GlobalConfigurationCategory getCategory()
      Overrides:
      getCategory in class Descriptor<GlobalConfiguration>