Package jetbrains.buildServer.agent.runner

Interface ProgramCommandLine

All Known Implementing Classes:

SimpleProgramCommandLine

@UserImplemented(adapterClass=SimpleProgramCommandLine.class)
public interface ProgramCommandLine

interface providing information to start the process

See Also:

BuildServiceAdapter.createProgramCommandline(String, java.util.List)

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getArguments()	All quotations are done property inside Java Runtime
default java.lang.String	getCommandLineForLogging(PasswordReplacer passwordReplacer)
java.util.Map<java.lang.String,java.lang.String>	getEnvironment()
java.lang.String	getExecutablePath()	Returns either full pathrelative path to working dirsimply command name to be resolved by OS on the build agent to run
java.lang.String	getWorkingDirectory()

Method Detail

getExecutablePath

@NotNull
java.lang.String getExecutablePath()
                            throws RunBuildException

Returns either

• full path
• relative path to working dir
• simply command name to be resolved by OS on the build agent

to run

Returns:

file path to execute

Throws:

RunBuildException - on error in parameters or agent's machine environment

getWorkingDirectory

@NotNull
java.lang.String getWorkingDirectory()
                              throws RunBuildException

Returns:

executable working directory either relative on build checkout directory or absolute path

Throws:

RunBuildException - on error in parameters or agent's machine environment

getArguments

@NotNull
java.util.List<java.lang.String> getArguments()
                                       throws RunBuildException

All quotations are done property inside Java Runtime

Returns:

arguments to be sent to process

Throws:

RunBuildException - on error in parameters or agent's machine environment

getCommandLineForLogging

default java.lang.String getCommandLineForLogging(PasswordReplacer passwordReplacer)
                                           throws RunBuildException

Returns:

command line for logging, i.e. this line will be logged into build and agent logs. So the plugin should replace all passwords in this command line using provided password replacer.

Throws:

RunBuildException

Since:

2022.10

getEnvironment

@NotNull
java.util.Map<java.lang.String,java.lang.String> getEnvironment()
                                                               throws RunBuildException

Returns:

map of all environment variables to be set for process

Throws:

RunBuildException - on error in parameters or agent's machine environment