Package org.jenkinsci.plugins.envinjectapi.util

Class EnvVarsResolver

java.lang.Object

org.jenkinsci.plugins.envinjectapi.util.EnvVarsResolver

public class EnvVarsResolver
extends Object

Provides utility methods for resolving environment variables.

Author:

Gregory Boissinot, Oleg Nenashev

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	getCauseEnvVars(Run<?,?> run)	Retrieves variables describing the Run cause.
static Map<String,String>	getEnVars(Run<?,?> run)
static Map<String,String>	getPollingEnvVars(Job<?,?> job, Node node)
static String	resolveEnvVars(Run<?,?> run, String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getPollingEnvVars

@NonNull
public static Map<String,String> getPollingEnvVars(@NonNull
 Job<?,?> job,
 @CheckForNull
 Node node)
                                            throws org.jenkinsci.lib.envinject.EnvInjectException

Throws:

org.jenkinsci.lib.envinject.EnvInjectException

getEnVars

@NonNull
public static Map<String,String> getEnVars(@NonNull
 Run<?,?> run)
                                    throws org.jenkinsci.lib.envinject.EnvInjectException

Throws:

org.jenkinsci.lib.envinject.EnvInjectException

resolveEnvVars

@CheckForNull
public static String resolveEnvVars(@NonNull
 Run<?,?> run,
 @CheckForNull
 String value)
                             throws org.jenkinsci.lib.envinject.EnvInjectException

Throws:

org.jenkinsci.lib.envinject.EnvInjectException

getCauseEnvVars

@NonNull
public static Map<String,String> getCauseEnvVars(@NonNull
 Run<?,?> run)

Retrieves variables describing the Run cause.

Parameters:

run - Run

Returns:

Set of environment variables, which depends on the cause type.