MasterToSlaveCallable (Jenkins core 2.362 API)

java.lang.Object
- jenkins.security.MasterToSlaveCallable<V,T>

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 Implemented Interfaces:

hudson.remoting.Callable<V,T>, Serializable, org.jenkinsci.remoting.RoleSensitive

Direct Known Subclasses:

ChannelPinger.SetUpRemotePing
```
public abstract class MasterToSlaveCallable<V,T extends Throwable>
extends Object
implements hudson.remoting.Callable<V,T>
```
Convenient Callable meant to be run on agent. Note that the logic within Callable.call() should use API of a minimum supported Remoting version. See RemotingVersionInfo.getMinimumSupportedVersion().

Since:

1.587 / 1.580.1

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

MasterToSlaveCallable()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`checkRoles(org.jenkinsci.remoting.RoleChecker checker)`
`hudson.remoting.Channel`	`getChannelOrFail()`
`hudson.remoting.Channel`	`getOpenChannelOrFail()`

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

Methods inherited from interface hudson.remoting.Callable
call

- Constructor Detail
  - MasterToSlaveCallable
```
public MasterToSlaveCallable()
```
- Method Detail
  - checkRoles
```
public void checkRoles(org.jenkinsci.remoting.RoleChecker checker)
                throws SecurityException
```
    Specified by:
    
    checkRoles in interface org.jenkinsci.remoting.RoleSensitive
    
    Throws:
    
    SecurityException
  - getChannelOrFail
```
public hudson.remoting.Channel getChannelOrFail()
                                         throws hudson.remoting.ChannelClosedException
```
    Specified by:
    
    getChannelOrFail in interface hudson.remoting.Callable<V,T extends Throwable>
    
    Throws:
    
    hudson.remoting.ChannelClosedException
  - getOpenChannelOrFail
```
public hudson.remoting.Channel getOpenChannelOrFail()
                                             throws hudson.remoting.ChannelClosedException
```
    Specified by:
    
    getOpenChannelOrFail in interface hudson.remoting.Callable<V,T extends Throwable>
    
    Throws:
    
    hudson.remoting.ChannelClosedException