AbstractFileCallable (Pipeline Utility Steps 2.20.0 API)

java.lang.Object

jenkins.MasterToSlaveFileCallable<T>

org.jenkinsci.plugins.pipeline.utility.steps.AbstractFileCallable<T>

All Implemented Interfaces:: FilePath.FileCallable<T>, Serializable, ControllerToAgentFileCallable<T>, org.jenkinsci.remoting.RoleSensitive

Direct Known Subclasses:: UnTarStepExecution.UnTarFileCallable, UnZipStepExecution.UnZipFileCallable

public abstract class AbstractFileCallable<T> extends MasterToSlaveFileCallable<T>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

AbstractFileCallable()
Method Summary

Modifier and Type

Method

Description

FilePath

getDestination()

boolean

isAllowExtractionOutsideDestination()

SECURITY-2169 escape hatch.

protected boolean

isDescendantOfDestination(FilePath f)

void

setAllowExtractionOutsideDestination(boolean allowExtractionOutsideDestination)

void

setDestination(FilePath destination)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jenkins.agents.ControllerToAgentFileCallable
checkRoles

Methods inherited from interface hudson.FilePath.FileCallable
invoke

Constructor Details
- AbstractFileCallable
  
  public AbstractFileCallable()
Method Details
- getDestination
  
  public FilePath getDestination()
- setDestination
  
  public void setDestination(FilePath destination)
- isAllowExtractionOutsideDestination
  
  public boolean isAllowExtractionOutsideDestination()
  
  SECURITY-2169 escape hatch. Controlled by DecompressStepExecution.ALLOW_EXTRACTION_OUTSIDE_DESTINATION.
  
  Returns:
  
  true if so.
- setAllowExtractionOutsideDestination
  
  public void setAllowExtractionOutsideDestination(boolean allowExtractionOutsideDestination)
- isDescendantOfDestination
  
  protected boolean isDescendantOfDestination(FilePath f) throws IOException
  
  Throws:
  
  IOException