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

Methods

Modifier and Type	Method and Description
Channel	build(SelectableChannel r, SelectableChannel w)
Channel	build(Socket s)
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	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)
NioChannelBuilder	withMode(Channel.Mode mode) The encoding to be used over the stream.
NioChannelBuilder	withRestricted(boolean restricted) If true, this channel won't accept Commands that allow the remote end to execute arbitrary closures --- instead they can only call methods on objects that are exported by this channel.

Methods inherited from class hudson.remoting.ChannelBuilder

build, build, getBaseLoader, getCapability, getExecutors, getHeaderStream, getJarCache, getMode, getName, isRestricted, makeTransport, negotiate

Methods inherited from class java.lang.Object

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

Method Detail

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

If true, this channel won't accept Commands that allow the remote end to execute arbitrary closures --- instead they can only call methods on objects that are exported by this channel. This also prevents the remote end from loading classes into JVM. Note that it still allows the remote end to deserialize arbitrary object graph (provided that all the classes are already available in this JVM), so exactly how safe the resulting behavior is is up to discussion.

Overrides:

withRestricted in class ChannelBuilder

withJarCache

public NioChannelBuilder withJarCache(JarCache jarCache)

Overrides:

withJarCache in class ChannelBuilder