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
,OnMaster
@Extension @Symbol("envInject") public class EnvInjectPluginConfiguration extends GlobalConfiguration
Configuration of security options forEnvInjectPlugin
.- Since:
- 1.92
- Author:
- Oleg Nenashev
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class hudson.model.Descriptor
Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
-
Fields inherited from class hudson.model.Descriptor
clazz
-
-
Constructor Summary
Constructors Constructor Description EnvInjectPluginConfiguration()
EnvInjectPluginConfiguration(boolean hideInjectedVars, boolean enablePermissions)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
GlobalConfigurationCategory
getCategory()
protected XmlFile
getConfigFile()
static EnvInjectPluginConfiguration
getDefault()
Gets the default configuration ofEnvInjectPlugin
static EnvInjectPluginConfiguration
getInstance()
static EnvInjectPluginConfiguration
getOrFail()
Retrieves the EnvInject global configuration.boolean
isEnableLoadingFromMaster()
Check if the instance supports loading of scripts and property files from the controller.boolean
isEnablePermissions()
boolean
isHideInjectedVars()
void
setEnableLoadingFromMaster(boolean enableLoadingFromMaster)
void
setEnablePermissions(boolean enabledPermissions)
void
setHideInjectedVars(boolean hideInjectedVars)
-
Methods inherited from class jenkins.model.GlobalConfiguration
all, getDescriptor, getGlobalConfigPage
-
Methods inherited from class hudson.model.Descriptor
addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCheckMethod, getCheckUrl, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, 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
-
-
-
-
Constructor Detail
-
EnvInjectPluginConfiguration
@DataBoundConstructor public EnvInjectPluginConfiguration()
-
EnvInjectPluginConfiguration
@Deprecated public EnvInjectPluginConfiguration(boolean hideInjectedVars, boolean enablePermissions)
Deprecated.- Since:
- 2.0 Loading of files from controller is disabled by default
-
-
Method Detail
-
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 ofEnvInjectPlugin
- Returns:
- Default configuration
-
getConfigFile
protected XmlFile getConfigFile()
- Overrides:
getConfigFile
in classDescriptor<GlobalConfiguration>
-
configure
public boolean configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json) throws Descriptor.FormException
- Overrides:
configure
in classGlobalConfiguration
- 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 classDescriptor<GlobalConfiguration>
-
-