Package jenkins.slaves

Class RemotingWorkDirSettings

java.lang.Object

jenkins.slaves.RemotingWorkDirSettings

All Implemented Interfaces:

Describable<RemotingWorkDirSettings>

public class RemotingWorkDirSettings
extends Object
implements Describable<RemotingWorkDirSettings>

Defines settings of the Remoting work directory. This class contains Remoting Work Directory settings, which can be used when starting Jenkins agents. See Remoting Work Dir Documentation.

Since:

2.72

Author:

Oleg Nenashev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemotingWorkDirSettings.DescriptorImpl

Constructor Summary

Constructors

Constructor	Description
RemotingWorkDirSettings()
RemotingWorkDirSettings(boolean disabled, String workDirPath, String internalDir, boolean failIfWorkDirIsMissing)

Method Summary

Modifier and Type	Method	Description
Descriptor<RemotingWorkDirSettings>	getDescriptor()	Gets the descriptor for this instance.
static RemotingWorkDirSettings	getDisabledDefaults()	Gets default settings for the disabled work directory.
static RemotingWorkDirSettings	getEnabledDefaults()	Gets default settings of the enabled work directory.
String	getInternalDir()
String	getWorkDirPath()	Gets path to the custom workdir path.
boolean	isDisabled()	Check if workdir is disabled.
boolean	isFailIfWorkDirIsMissing()	Check if startup should fail if the workdir is missing.
boolean	isUseAgentRootDir()	Indicates that agent root directory should be used as work directory.
List<String>	toCommandLineArgs(SlaveComputer computer)	Gets list of command-line arguments for the work directory.
String	toCommandLineString(SlaveComputer computer)	Gets a command line string, which can be passed to agent start command.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemotingWorkDirSettings

@DataBoundConstructor
public RemotingWorkDirSettings(boolean disabled,
                               @CheckForNull
                               String workDirPath,
                               @CheckForNull
                               String internalDir,
                               boolean failIfWorkDirIsMissing)

RemotingWorkDirSettings

public RemotingWorkDirSettings()

Method Detail

isDisabled

public boolean isDisabled()

Check if workdir is disabled.

Returns:

true if the property is disabled. In such case Remoting will use the legacy mode.

isUseAgentRootDir

public boolean isUseAgentRootDir()

Indicates that agent root directory should be used as work directory.

Returns:

true if the agent root should be a work directory.

isFailIfWorkDirIsMissing

public boolean isFailIfWorkDirIsMissing()

Check if startup should fail if the workdir is missing.

Returns:

true if Remoting should fail if the the work directory is missing instead of creating it

getWorkDirPath

@CheckForNull
public String getWorkDirPath()

Gets path to the custom workdir path.

Returns:

Custom workdir path. If null, an agent root directory path should be used instead.

getInternalDir

@NonNull
public String getInternalDir()

getDescriptor

public Descriptor<RemotingWorkDirSettings> getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<RemotingWorkDirSettings>

toCommandLineArgs

public List<String> toCommandLineArgs(@NonNull
                                      SlaveComputer computer)

Gets list of command-line arguments for the work directory.

Parameters:

computer - Computer, for which the arguments are being created

Returns:

Non-modifiable list of command-line arguments

toCommandLineString

@NonNull
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public String toCommandLineString(@NonNull
                                  SlaveComputer computer)

Gets a command line string, which can be passed to agent start command.

Parameters:

computer - Computer, for which the arguments need to be constructed.

Returns:

Command line arguments. It may be empty if the working directory is disabled or if the Computer type is not SlaveComputer.

getDisabledDefaults

@NonNull
public static RemotingWorkDirSettings getDisabledDefaults()

Gets default settings for the disabled work directory.

Returns:

Legacy value: disabled work directory.

getEnabledDefaults

@NonNull
public static RemotingWorkDirSettings getEnabledDefaults()

Gets default settings of the enabled work directory.