Package jenkins.agents

Interface ControllerToAgentCallable<V,T extends Throwable>

Type Parameters:
V - the return type; note that this must either be defined in your plugin or included in the stock JEP-200 whitelist
All Superinterfaces:
hudson.remoting.Callable<V,T>, org.jenkinsci.remoting.RoleSensitive, Serializable
All Known Implementing Classes:
ChannelPinger.SetUpRemotePing, MasterToSlaveCallable
public interface ControllerToAgentCallable<V,T extends Throwable> extends hudson.remoting.Callable<V,T>
Callable meant to be serialized then run on an agent. A typical implementation will be a Record since instance state merely transfers a set of parameters to an agent JVM.

Note that the logic within Callable.call() may not use Remoting APIs newer than RemotingVersionInfo.getMinimumSupportedVersion(). (Core and plugin APIs will be identical to those run inside the controller.)

Since:
2.485

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    checkRoles(org.jenkinsci.remoting.RoleChecker checker)
     

    Methods inherited from interface hudson.remoting.Callable

    call, getChannelOrFail, getOpenChannelOrFail

  • Method Details

    • checkRoles

      default void checkRoles(org.jenkinsci.remoting.RoleChecker checker) throws SecurityException
      Specified by:
      checkRoles in interface org.jenkinsci.remoting.RoleSensitive
      Throws:
      SecurityException