Package jenkins.security

Class ChannelConfigurator

java.lang.Object

jenkins.security.ChannelConfigurator

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

CallableDirectionChecker.ChannelConfiguratorImpl

public abstract class ChannelConfigurator
extends Object
implements ExtensionPoint

Intercepts the new creation of Channel and tweak its configuration.

Since:

1.587 / 1.580.1

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
ChannelConfigurator()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<ChannelConfigurator>	all()	All the registered ChannelConfigurators.
void	onChannelBuilding(hudson.remoting.ChannelBuilder builder, Object context)	Called whenever a new channel is being built.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChannelConfigurator

public ChannelConfigurator()

Method Details

onChannelBuilding

public void onChannelBuilding(hudson.remoting.ChannelBuilder builder,
 @Nullable
 Object context)

Called whenever a new channel is being built.

Parameters:

builder - Configures the newly built channel. The callee can call its methods to modify its settings.

context - The parameter that helps the callee determines what this channel is for. Legacy callers do not always provide this information, in which case this value might be null. Possible known values include:

SlaveComputer

When a channel is being established to talk to a agent.

Proc

When Channels.forProcess(String, ExecutorService, Process, OutputStream) or overloads are used without a contextual SlaveComputer.

all

public static ExtensionList<ChannelConfigurator> all()

All the registered ChannelConfigurators.