Package jenkins.slaves

Class RemotingWorkDirSettings

java.lang.Object
jenkins.slaves.RemotingWorkDirSettings
All Implemented Interfaces:
Describable<RemotingWorkDirSettings>
@Deprecated public class RemotingWorkDirSettings extends Object implements Describable<RemotingWorkDirSettings>
Deprecated.
only used with deprecated -jnlpUrl mode

  • Constructor Details

    • RemotingWorkDirSettings

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

    • RemotingWorkDirSettings

      public RemotingWorkDirSettings()
      Deprecated.

  • Method Details

    • isConfigured

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public boolean isConfigured()
      Deprecated.
      if this is not ENABLED_DEFAULT

    • isDisabled

      public boolean isDisabled()
      Deprecated.
      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()
      Deprecated.
      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()
      Deprecated.
      Check if startup should fail if the workdir is missing.
      Returns:
      true if Remoting should fail if the work directory is missing instead of creating it

    • getWorkDirPath

      @CheckForNull public String getWorkDirPath()
      Deprecated.
      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()
      Deprecated.

    • getDescriptor

      public Descriptor<RemotingWorkDirSettings> getDescriptor()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      Gets default settings for the disabled work directory.
      Returns:
      Legacy value: disabled work directory.

    • getEnabledDefaults

      @NonNull public static RemotingWorkDirSettings getEnabledDefaults()
      Deprecated.
      Gets default settings of the enabled work directory.