Class EnvInjectEnvVars
- java.lang.Object
-
- org.jenkinsci.plugins.envinject.service.EnvInjectEnvVars
-
- All Implemented Interfaces:
Serializable
public class EnvInjectEnvVars extends Object implements Serializable
- Author:
- Gregory Boissinot
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EnvInjectEnvVars(org.jenkinsci.lib.envinject.EnvInjectLogger logger)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Map<String,String>
executeAndGetMapGroovyScript(org.jenkinsci.lib.envinject.EnvInjectLogger logger, String scriptContent, Map<String,String> envVars)
Deprecated.Map<String,String>
executeGroovyScript(org.jenkinsci.lib.envinject.EnvInjectLogger logger, org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript script, Map<String,String> envVars)
Executes theSecureGroovyScript
and returns a map generated by the script/int
executeScript(boolean loadFromMaster, String scriptContent, FilePath scriptExecutionRoot, String scriptFilePath, Map<String,String> infraEnvVarsMaster, Map<String,String> infraEnvVarsNode, Launcher launcher, BuildListener listener)
int
executeScript(String scriptContent, FilePath scriptExecutionRoot, String scriptFilePath, Map<String,String> envVars, Launcher launcher, BuildListener listener)
Map<String,String>
getEnvVarsFileProperty(FilePath rootPath, org.jenkinsci.lib.envinject.EnvInjectLogger logger, String propertiesFilePath, Map<String,String> propertiesContent, Map<String,String> currentEnvVars)
Map<String,String>
getEnvVarsPropertiesJobProperty(FilePath rootPath, org.jenkinsci.lib.envinject.EnvInjectLogger logger, boolean loadFilesFromMaster, String propertiesFilePath, Map<String,String> propertiesContent, Map<String,String> infraEnvVarsMaster, Map<String,String> infraEnvVarsNode)
Map<String,String>
getMergedVariables(Map<String,String> infraEnvVars, Map<String,String> propertiesEnvVars)
Map<String,String>
getMergedVariables(Map<String,String> infraEnvVars, Map<String,String> propertiesEnvVars, Map<String,String> groovyMapEnvVars, Map<String,String> contribEnvVars)
Map<String,String>
removeUnsetVars(Map<String,String> envVars)
void
resolveVars(Map<String,String> variables, Map<String,String> env)
-
-
-
Method Detail
-
getEnvVarsPropertiesJobProperty
public Map<String,String> getEnvVarsPropertiesJobProperty(@NonNull FilePath rootPath, @NonNull org.jenkinsci.lib.envinject.EnvInjectLogger logger, boolean loadFilesFromMaster, @CheckForNull String propertiesFilePath, @CheckForNull Map<String,String> propertiesContent, @NonNull Map<String,String> infraEnvVarsMaster, @NonNull Map<String,String> infraEnvVarsNode) throws org.jenkinsci.lib.envinject.EnvInjectException
- Throws:
org.jenkinsci.lib.envinject.EnvInjectException
-
getEnvVarsFileProperty
@NonNull public Map<String,String> getEnvVarsFileProperty(@NonNull FilePath rootPath, @NonNull org.jenkinsci.lib.envinject.EnvInjectLogger logger, @CheckForNull String propertiesFilePath, @CheckForNull Map<String,String> propertiesContent, @NonNull Map<String,String> currentEnvVars) throws org.jenkinsci.lib.envinject.EnvInjectException
- Throws:
org.jenkinsci.lib.envinject.EnvInjectException
-
executeScript
public int executeScript(boolean loadFromMaster, @CheckForNull String scriptContent, @CheckForNull FilePath scriptExecutionRoot, @CheckForNull String scriptFilePath, @NonNull Map<String,String> infraEnvVarsMaster, @NonNull Map<String,String> infraEnvVarsNode, @NonNull Launcher launcher, @NonNull BuildListener listener) throws org.jenkinsci.lib.envinject.EnvInjectException
- Throws:
org.jenkinsci.lib.envinject.EnvInjectException
-
executeAndGetMapGroovyScript
@Deprecated @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) @RestrictedSince("2.0") public Map<String,String> executeAndGetMapGroovyScript(@NonNull org.jenkinsci.lib.envinject.EnvInjectLogger logger, @CheckForNull String scriptContent, @NonNull Map<String,String> envVars) throws org.jenkinsci.lib.envinject.EnvInjectException, AbortException
Deprecated.Executes a groovy script and returns the result as a map. The script will be executed in aSecureGroovyScript
without the sandbox, so chances are low that it will succeed unless an exact copy has already been approved.- Parameters:
logger
- the loggerscriptContent
- the scriptenvVars
- variables to bind to the script- Returns:
- the result as a map
- Throws:
org.jenkinsci.lib.envinject.EnvInjectException
- if soAbortException
- if so- Since:
- 1.38 - Initial implementation, 2.0 - Uses Secure Groovy Script. It will require approvals for non-admin users It is also restricted.
- See Also:
executeGroovyScript(EnvInjectLogger, SecureGroovyScript, Map)
-
executeGroovyScript
@NonNull @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public Map<String,String> executeGroovyScript(@NonNull org.jenkinsci.lib.envinject.EnvInjectLogger logger, @CheckForNull org.jenkinsci.plugins.scriptsecurity.sandbox.groovy.SecureGroovyScript script, @NonNull Map<String,String> envVars) throws org.jenkinsci.lib.envinject.EnvInjectException, AbortException
Executes theSecureGroovyScript
and returns a map generated by the script/- Parameters:
logger
- a loggerscript
- the scriptenvVars
- any variables to bind to the script's context- Returns:
- the map
- Throws:
org.jenkinsci.lib.envinject.EnvInjectException
- for any exceptions generated by the script executionAbortException
- if something is badly wrong.- Since:
- 2.0
-
executeScript
public int executeScript(@CheckForNull String scriptContent, @CheckForNull FilePath scriptExecutionRoot, @CheckForNull String scriptFilePath, @NonNull Map<String,String> envVars, @NonNull Launcher launcher, @NonNull BuildListener listener) throws org.jenkinsci.lib.envinject.EnvInjectException
- Throws:
org.jenkinsci.lib.envinject.EnvInjectException
-
getMergedVariables
@NonNull public Map<String,String> getMergedVariables(@NonNull Map<String,String> infraEnvVars, @NonNull Map<String,String> propertiesEnvVars)
-
getMergedVariables
@NonNull public Map<String,String> getMergedVariables(@NonNull Map<String,String> infraEnvVars, @NonNull Map<String,String> propertiesEnvVars, @NonNull Map<String,String> groovyMapEnvVars, @NonNull Map<String,String> contribEnvVars)
-
resolveVars
public void resolveVars(@NonNull Map<String,String> variables, @NonNull Map<String,String> env)
-
-