public class EnvVars extends TreeMap<String,String>
While all the platforms I tested (Linux 2.6, Solaris, and Windows XP) have the case sensitive
environment variable table, Windows batch script handles environment variable in the case preserving
but case insensitive way (that is, cmd.exe can get both FOO and foo as environment variables
when it's launched, and the "set" command will display it accordingly, but "echo %foo%" results in
echoing the value of "FOO", not "foo" — this is presumably caused by the behavior of the underlying
Win32 API GetEnvironmentVariable acting in case insensitive way.) Windows users are also
used to write environment variable case-insensitively (like %Path% vs %PATH%), and you can see many
documents on the web that claims Windows environment variables are case insensitive.
So for a consistent cross platform behavior, it creates the least confusion to make the table case insensitive but case preserving.
In Jenkins, often we need to build up "environment variable overrides"
on master, then to execute the process on agents. This causes a problem
when working with variables like PATH. So to make this work,
we introduce a special convention PATH+FOO — all entries
that starts with PATH+ are merged and prepended to the inherited
PATH variable, on the process where a new process is executed.
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>| Modifier and Type | Field and Description |
|---|---|
static Map<String,String> |
masterEnvVars
Environmental variables that we've inherited.
|
| Constructor and Description |
|---|
EnvVars() |
EnvVars(EnvVars m) |
EnvVars(Map<String,String> m) |
EnvVars(String... keyValuePairs)
Builds an environment variables from an array of the form
"key","value","key","value"... |
| Modifier and Type | Method and Description |
|---|---|
void |
addLine(String line)
Takes a string that looks like "a=b" and adds that to this map.
|
static EnvVars |
createCookie()
Creates a magic cookie that can be used as the model environment variable
when we later kill the processes.
|
String |
expand(String s)
Expands the variables in the given string by using environment variables represented in 'this'.
|
String |
get(String key,
String defaultValue)
Convenience message
|
Platform |
getPlatform()
Gets the platform for which these env vars targeted.
|
static EnvVars |
getRemote(hudson.remoting.VirtualChannel channel)
Obtains the environment variables of a remote peer.
|
void |
override(String key,
String value)
Overrides the current entry by the given entry.
|
EnvVars |
overrideAll(Map<String,String> all)
Overrides all values in the map by the given map.
|
EnvVars |
overrideExpandingAll(Map<String,String> all)
Overrides all values in the map by the given map.
|
String |
put(String key,
String value) |
void |
putIfNotNull(String key,
String value)
Add a key/value but only if the value is not-null.
|
static void |
resolve(Map<String,String> env)
Resolves environment variables against each other.
|
void |
setPlatform(Platform platform)
Sets the platform for which these env vars target.
|
ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, valuesequals, hashCode, isEmpty, toStringfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, removepublic static final Map<String,String> masterEnvVars
Despite what the name might imply, this is the environment variable of the current JVM process. And therefore, it is Jenkins master's environment variables only when you access this from the master.
If you access this field from agents, then this is the environment variable of the agent.
public EnvVars()
public EnvVars(String... keyValuePairs)
"key","value","key","value"...@CheckForNull public Platform getPlatform()
public void setPlatform(@Nonnull Platform platform)
platform - the platform to set.public void override(String key, String value)
Handles PATH+XYZ notation.
public EnvVars overrideAll(Map<String,String> all)
override(String, String).public EnvVars overrideExpandingAll(@Nonnull Map<String,String> all)
override(String, String).thispublic static void resolve(Map<String,String> env)
public void putIfNotNull(String key, String value)
public void addLine(String line)
public String expand(String s)
public static EnvVars createCookie()
public static EnvVars getRemote(hudson.remoting.VirtualChannel channel) throws IOException, InterruptedException
channel - Can be null, in which case the map indicating "N/A" will be returned.IOExceptionInterruptedExceptionCopyright © 2004–2019. All rights reserved.