hudson

Interface FilePath.FileCallable<T>

All Superinterfaces:

org.jenkinsci.remoting.RoleSensitive, Serializable

All Known Implementing Classes:

DiskSpaceMonitorDescriptor.GetUsableSpace, MasterToSlaveFileCallable, SlaveToMasterFileCallable, TemporarySpaceMonitor.GetTempSpace

Enclosing class:

FilePath

public static interface FilePath.FileCallable<T>
extends Serializable, org.jenkinsci.remoting.RoleSensitive

Code that gets executed on the machine where the FilePath is local. Used to act on FilePath. Warning: implementations must be serializable, so prefer a static nested class to an inner class.

Subtypes would likely want to extend from either MasterToSlaveCallable or SlaveToMasterFileCallable.

See Also:

FilePath.act(FileCallable)

Method Summary

Modifier and Type	Method and Description
T	invoke(File f, hudson.remoting.VirtualChannel channel) Performs the computational task on the node where the data is located.

Methods inherited from interface org.jenkinsci.remoting.RoleSensitive

checkRoles

Method Detail

invoke

T invoke(File f,
         hudson.remoting.VirtualChannel channel)
  throws IOException,
         InterruptedException

Performs the computational task on the node where the data is located.

All the exceptions are forwarded to the caller.

Parameters:

f - File that represents the local file that FilePath has represented.

channel - The "back pointer" of the Channel that represents the communication with the node from where the code was sent.

Throws:

IOException

InterruptedException