com.atlassian.bamboo.v2.build.agent.capability

Class ExecutablePathUtils

java.lang.Object

com.atlassian.bamboo.v2.build.agent.capability.ExecutablePathUtils

public final class ExecutablePathUtils
extends Object

Method Summary

Modifier and Type	Method and Description
static File	detectExecutableOnPath(String executableName) Detects the executable home directory and validates that it matches the required pattern using existsInHomeBinExePattern(String, String)
static boolean	existsInHomeBinExePattern(String homePath, String executableName) Validates that the executable exists at the path ${homePath}/bin/${executableName} Appends ".bat" to the executable name if the platform is Windows
static File	findExecutable(String executableName, com.google.common.base.Predicate<File> validityPredicate, String envHomeDir, List<String> fhsHomes) This method will return the executable home path, searching first in environment home, then on PATH, finally in a FHS - compliant directory.
static File	findExecutable(String executableName, com.google.common.base.Predicate<File> validityPredicate, String envHomeDir, String fhsHome) This method will return the executable home path, searching first in environment home, then on PATH, finally in a FHS - compliant directory.
static String	findExecutablePath(String executableName) Finds the path of the executable given its name.
static Optional<File>	getExistingExecutable(String basePath, String executableName)
static File	getHomeFromExecutableInHomeBin(File executable) Gets the home directory for an executable if its parent directory is 'bin'
static String	makeBatchIfOnWindows(String builder)

Methods inherited from class java.lang.Object

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

Method Detail

existsInHomeBinExePattern

public static boolean existsInHomeBinExePattern(@Nullable
                                                String homePath,
                                                @NotNull
                                                String executableName)

Validates that the executable exists at the path ${homePath}/bin/${executableName} Appends ".bat" to the executable name if the platform is Windows

Parameters:

homePath -

executableName -

Returns:

matches

getExistingExecutable

public static Optional<File> getExistingExecutable(@Nullable
                                                   String basePath,
                                                   @NotNull
                                                   String executableName)

makeBatchIfOnWindows

@NotNull
public static String makeBatchIfOnWindows(String builder)

detectExecutableOnPath

@Nullable
public static File detectExecutableOnPath(@NotNull
                                                    String executableName)

Detects the executable home directory and validates that it matches the required pattern using existsInHomeBinExePattern(String, String)

Parameters:

executableName - of the builder executable

Returns:

home

getHomeFromExecutableInHomeBin

@Nullable
public static File getHomeFromExecutableInHomeBin(@NotNull
                                                            File executable)

Gets the home directory for an executable if its parent directory is 'bin'

Parameters:

executable - the executable file used to detect the home directory

Returns:

homeDir

findExecutable

@Nullable
public static File findExecutable(@NotNull
                                            String executableName,
                                            @Nullable
                                            com.google.common.base.Predicate<File> validityPredicate,
                                            @Nullable
                                            String envHomeDir,
                                            @Nullable
                                            String fhsHome)

This method will return the executable home path, searching first in environment home, then on PATH, finally in a FHS - compliant directory.

Parameters:

executableName - executable name to search for

validityPredicate - predicate used to validate the executable path

envHomeDir - home directory from environment

fhsHome - FHS-compliant home directory

Returns:

file to executable

findExecutable

@Nullable
public static File findExecutable(@NotNull
                                            String executableName,
                                            @Nullable
                                            com.google.common.base.Predicate<File> validityPredicate,
                                            @Nullable
                                            String envHomeDir,
                                            @NotNull
                                            List<String> fhsHomes)

This method will return the executable home path, searching first in environment home, then on PATH, finally in a FHS - compliant directory.

Parameters:

executableName - executable name to search for

validityPredicate - predicate used to validate the executable path

envHomeDir - home directory from environment

fhsHomes - FHS-compliant home directory

Returns:

file to executable

findExecutablePath

@Nullable
public static String findExecutablePath(@NotNull
                                                  String executableName)

Finds the path of the executable given its name.

Parameters:

executableName - of the executable

Returns:

path