Package org.jenkinsci.remoting.nio

Class NioChannelBuilder

java.lang.Object

hudson.remoting.ChannelBuilder

org.jenkinsci.remoting.nio.NioChannelBuilder

public abstract class NioChannelBuilder
extends ChannelBuilder

ChannelBuilder subtype for NioChannelHub.

Since:

2.38

Author:

Kohsuke Kawaguchi

See Also:

• NioChannelHub.newChannelBuilder(String, ExecutorService)

Method Summary

Modifier and Type	Method	Description
Channel	build(Socket s)
Channel	build(SelectableChannel r, SelectableChannel w)
Channel	build(SocketChannel socket)
NioChannelBuilder	withBaseLoader(ClassLoader base)	Specify the classloader used for deserializing remote commands.
NioChannelBuilder	withCapability(Capability capability)	Controls the capabilities that we'll advertise to the other side.
NioChannelBuilder	withClassFilter(ClassFilter filter)	Replaces the ClassFilter used by the channel.
NioChannelBuilder	withHeaderStream(OutputStream header)	If non-null, receive the portion of data in is before the data goes into the "binary mode".
NioChannelBuilder	withJarCache(JarCache jarCache)	Sets the JAR cache storage.
NioChannelBuilder	withMode(Channel.Mode mode)	The encoding to be used over the stream.
NioChannelBuilder	withoutJarCache()	Resets JAR Cache setting to the default.
NioChannelBuilder	withRestricted(boolean restricted)	For compatibility reasons, activates/disables all the security restriction features.

Methods inherited from class hudson.remoting.ChannelBuilder

build, build, getBaseLoader, getCapability, getClassFilter, getDecorators, getExecutors, getHeaderStream, getJarCache, getMode, getName, getProperties, isArbitraryCallableAllowed, isRemoteClassLoadingAllowed, isRestricted, makeTransport, negotiate, with, withArbitraryCallableAllowed, withJarCacheOrDefault, withProperty, withProperty, withRemoteClassLoadingAllowed, withRoleChecker, withRoles, withRoles

Methods inherited from class java.lang.Object

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

Method Details

build

public Channel build(SocketChannel socket)
              throws IOException

Overrides:

build in class ChannelBuilder

Throws:

IOException

build

public Channel build(SelectableChannel r,
 SelectableChannel w)
              throws IOException

Throws:

IOException

build

public Channel build(Socket s)
              throws IOException

Overrides:

build in class ChannelBuilder

Throws:

IOException

withBaseLoader

public NioChannelBuilder withBaseLoader(ClassLoader base)

Description copied from class: ChannelBuilder

Specify the classloader used for deserializing remote commands. This is primarily related to Channel.getRemoteProperty(Object). Sometimes two parties communicate over a channel and pass objects around as properties, but those types might not be visible from the classloader loading the Channel class. In such a case, specify a classloader so that those classes resolve. If null, Channel.class.getClassLoader() is used.

Overrides:

withBaseLoader in class ChannelBuilder

withMode

public NioChannelBuilder withMode(Channel.Mode mode)

Description copied from class: ChannelBuilder

The encoding to be used over the stream.

Overrides:

withMode in class ChannelBuilder

withCapability

public NioChannelBuilder withCapability(Capability capability)

Description copied from class: ChannelBuilder

Controls the capabilities that we'll advertise to the other side.

Overrides:

withCapability in class ChannelBuilder

withHeaderStream

public NioChannelBuilder withHeaderStream(OutputStream header)

Description copied from class: ChannelBuilder

If non-null, receive the portion of data in is before the data goes into the "binary mode". This is useful when the established communication channel might include some data that might be useful for debugging/trouble-shooting.

Overrides:

withHeaderStream in class ChannelBuilder

withRestricted

public NioChannelBuilder withRestricted(boolean restricted)

Description copied from class: ChannelBuilder

For compatibility reasons, activates/disables all the security restriction features.

Overrides:

withRestricted in class ChannelBuilder

withJarCache

public NioChannelBuilder withJarCache(JarCache jarCache)

Description copied from class: ChannelBuilder

Sets the JAR cache storage.

Overrides:

withJarCache in class ChannelBuilder

Parameters:

jarCache - JAR Cache to be used. If a deprecated null value is passed, the behavior will be determined by the Channel implementation.

Returns:

this

withoutJarCache

public NioChannelBuilder withoutJarCache()

Description copied from class: ChannelBuilder

Resets JAR Cache setting to the default. The behavior will be determined by the Channel implementation.

Overrides:

withoutJarCache in class ChannelBuilder

withClassFilter

public NioChannelBuilder withClassFilter(ClassFilter filter)

Description copied from class: ChannelBuilder

Replaces the ClassFilter used by the channel. By default, ClassFilter.DEFAULT is installed.

Overrides:

withClassFilter in class ChannelBuilder