Package hudson.remoting

Remoting infrastructure for Hudson.

Code in this package is used for running a part of a program in agents. If you are new to this package, start from Channel.

Interface Summary

Interface	Description
AbstractByteArrayCommandTransport.ByteArrayReceiver
Callable<V,T extends Throwable>	Represents computation to be done on a remote system.
CallableFilter	Deprecated. Use CallableDecorator
CommandTransport.CommandReceiver	SPI implemented by Channel so that the transport can pass the received command to Channel for processing.
DelegatingCallable<V,T extends Throwable>	Callable that nominates another classloader for serialization.
EngineListener	Receives status notification from Engine.
ErrorPropagatingOutputStream	OutputStream that's connected to an InputStream somewhere, which provides ability to have InputStream report an error.
Future<V>	Alias to Future.
IReadResolve	Used internally in the remoting code to have the proxy object implement readResolve.
JarLoader	Remoting interface to allow the other side to retrieve a jar file from the checksum advertised in ResourceImageInJar.
VirtualChannel	Virtualized Channel that allows different implementations.

Class Summary

Class	Description
AbstractByteArrayCommandTransport	CommandTransport that works with byte[] instead of command object.
AbstractByteBufferCommandTransport	A CommandTransport that uses ByteBuffer rather than byte.
AbstractSynchronousByteArrayCommandTransport	SynchronousCommandTransport that works with byte[] instead of command object.
AsyncFutureImpl<V>	Future implementation whose computation is carried out elsewhere.
AtmostOneThreadExecutor	ExecutorService that uses at most one executor.
Base64	Deprecated. Use Base64 instead
BinarySafeStream	Tunnels byte stream into another byte stream so that binary data can be sent across binary-unsafe stream.
Capability	Represents additional features implemented on Channel.
Channel	Represents a communication channel to the remote peer.
Channel.Listener	Callback "interface" for changes in the state of Channel.
ChannelBuilder	Factory for Channel, including hand-shaking between two sides and various configuration switches to change the behaviour of Channel.
ChannelProperty<T>	A convenient key type for Channel.getProperty(Object) and Channel.setProperty(Object, Object)
ChunkHeader	Parsing of the chunk header.
ClassFilter	Restricts what classes can be received through remoting.
ClassLoaderHolder	Remoting-aware holder of ClassLoader that replaces ClassLoader by its RemoteClassLoader.
Command	One-way command to be sent over to the remote system and executed there.
CommandTransport	Lower level abstraction under Channel for sending and receiving commands
DaemonThreadFactory
Engine	Agent engine that proactively connects to Jenkins controller.
EngineListenerAdapter	Adapter class for EngineListener to shield subtypes from future callback additions.
EngineListenerSplitter	EngineListener that distributes callbacks.
FastPipedInputStream	This class is equivalent to java.io.PipedInputStream.
FastPipedOutputStream	This class is equivalent to java.io.PipedOutputStream.
FileSystemJarCache	JarCache that stores files in a single directory.
HexDump
InitializeJarCacheMain	Takes a directory of jars and populates them into the given jar cache directory with the correct hash names.
JarCache	Jar file cache.
JarCacheSupport	Default partial implementation of JarCache.
Launcher	Entry point for running a Channel.
LocalChannel	VirtualChannel that performs computation on the local JVM.
NamingThreadFactory	Thread factory that sets thread name so we know who is responsible for so many threads being created.
NoProxyEvaluator
ObjectInputStreamEx	ObjectInputStream that uses a specific ClassLoader and can use a ClassFilter to limit what classes can be loaded.
PingThread	Periodically perform a ping.
Pipe	Pipe for the remote Callable and the local program to talk to each other.
RemoteInputStream	Wraps InputStream so that it can be sent over the remoting channel.
RemoteOutputStream	OutputStream that can be sent over to the remote Channel, so that the remote Callable can write to a local OutputStream.
RemoteWriter	Writer that can be sent over to the remote Channel, so that the remote Callable can write to a local Writer.
Request<RSP extends Serializable,EXC extends Throwable>	Request/response pattern over Channel, the layer-1 service.
Response<RSP extends Serializable,EXC extends Throwable>	Request/response pattern over Command.
SingleLaneExecutorService	Creates an ExecutorService that executes submitted tasks sequentially on top of another generic arbitrary ExecutorService.
SocketChannelStream	Wraps SocketChannel into InputStream/OutputStream in a way that avoids deadlock when read/write happens concurrently.
SocketInputStream	InputStream connected to socket.
SocketOutputStream	InputStream connected to socket.
StandardOutputStream	Hint that indicates that we are using stdout with fd=1 as the stream to write to for the channel.
SynchronousCommandTransport	CommandTransport that implements the read operation in a synchronous fashion.
TeeOutputStream	Classic splitter of OutputStream.
UnexportCommand	Command that unexports an object.
URLDeserializationHelper	SECURITY-637, this helper wraps the URL into a "safe" version if the url has a non-empty host and the JVM configuration is standard.
Util	Misc.
Which	Locates where a given class is loaded from.

Enum Summary

Enum	Description
Channel.Mode	Communication mode used in conjunction with ClassicCommandTransport.
RemoteInputStream.Flag

Exception Summary

Exception	Description
ChannelClosedException	Indicates that the channel is already closed or being closed.
ClassFilter.ClassFilterException	Deprecated. Only used by deprecated ClassFilter.appendDefaultFilter(java.util.regex.Pattern).
DiagnosedStreamCorruptionException	Signals a StreamCorruptedException with some additional diagnostic information.
ProxyException	Used when the exception thrown by the remoted code cannot be serialized.
RequestAbortedException	Signals that the communication is aborted and thus the pending Request will never recover its Response.

Annotation Types Summary

Annotation Type	Description
Asynchronous	Used on a method in a remotable exported interface to designate that the call is made asynchronously.