Deprecated API

Contents

• Interfaces
• Classes
• Exception Classes
• Fields
• Methods
• Constructors

Deprecated Interfaces

Interface	Description
hudson.remoting.CallableFilter	Use CallableDecorator
hudson.remoting.JarURLValidator	Do not use, intended as a temporary workaround only.

Deprecated Classes

Class	Description
hudson.remoting.Base64	Use Base64 instead
hudson.remoting.EngineListenerAdapter	Implement EngineListener directly.
hudson.remoting.forward.ForwarderFactory
hudson.remoting.forward.PortForwarder
hudson.remoting.jnlp.Main	use Launcher

Deprecated Exception Classes

Exception Class	Description
hudson.remoting.ClassFilter.ClassFilterException	Only used by deprecated ClassFilter.appendDefaultFilter(java.util.regex.Pattern).
org.jenkinsci.remoting.protocol.impl.PermanentConnectionRefusalException	Does not actually do what it claims; only affects logging levels.

Deprecated Fields

Field	Description
hudson.remoting.ClassFilter.FILE_OVERRIDE_LOCATION_PROPERTY	use ClassFilter.setDefault(hudson.remoting.ClassFilter) as needed
hudson.remoting.Engine.listener	Use Engine.events.
hudson.remoting.Launcher.agentJnlpURL	use Launcher.secret, Launcher.name, Launcher.urls, Launcher.webSocket, Launcher.tunnel, Launcher.workDir, Launcher.internalDir, and/or Launcher.failIfWorkDirIsMissing directly.
hudson.remoting.Launcher.args	use Launcher.secret and Launcher.name
hudson.remoting.Launcher.auth	use Launcher.agentJnlpCredentials or Launcher.proxyCredentials
hudson.remoting.Launcher.connectionTarget	removed without replacement
hudson.remoting.Launcher.headlessMode	removed without replacement
hudson.remoting.Launcher.ping	removed without replacement
hudson.remoting.Launcher.tcpPortFile	removed without replacement

Deprecated Methods

Method	Description
hudson.remoting.AbstractByteBufferCommandTransport.write(ByteBuffer, ByteBuffer)	pass true to AbstractByteBufferCommandTransport(boolean) and implement AbstractByteBufferCommandTransport.write(ByteBuffer)
hudson.remoting.Capability.hasMimicException()	no longer used
hudson.remoting.Channel.addLocalExecutionInterceptor(CallableFilter)	use Channel.addLocalExecutionInterceptor(CallableDecorator)
hudson.remoting.Channel.createLocalToRemotePortForwarding(int, String, int)	as of 3.39
hudson.remoting.Channel.createRemoteToLocalPortForwarding(int, String, int)	as of 3.39
hudson.remoting.Channel.getUnderlyingOutput()	Future version of the remoting module may add other modes of creating channel that doesn't involve stream pair. Therefore, we aren't committing to this method. This method isn't a part of the committed API of the channel class.
hudson.remoting.Channel.isRestricted()	Use methods like Channel.isRemoteClassLoadingAllowed() and Channel.isArbitraryCallableAllowed() to test individual features.
hudson.remoting.Channel.removeLocalExecutionInterceptor(CallableFilter)	use Channel.removeLocalExecutionInterceptor(CallableDecorator)
hudson.remoting.Channel.setRestricted(boolean)	Use methods like Channel.setRemoteClassLoadingAllowed(boolean) and Channel.setArbitraryCallableAllowed(boolean) to control individual features.
hudson.remoting.Channel.waitForRemoteProperty(ChannelProperty<T>)	Because ChannelProperty is identity-equality, this method would never work. This is a design error.
hudson.remoting.ChannelBuilder.isRestricted()	Test individual features instead.
hudson.remoting.ChannelBuilder.withRestricted(boolean)	Control individual features.
hudson.remoting.ClassFilter.appendDefaultFilter(Pattern)	use ClassFilter.setDefault(hudson.remoting.ClassFilter) as needed
hudson.remoting.Launcher.main(InputStream, OutputStream, Channel.Mode, boolean)	Use Launcher.main(InputStream, OutputStream, Channel.Mode, boolean, JarCache)
hudson.remoting.Launcher.setAuth(String)	use Launcher.agentJnlpCredentials or Launcher.proxyCredentials
hudson.remoting.Launcher.setConnectTo(String)	removed without replacement
hudson.remoting.Launcher.setHeadlessMode(boolean)	removed without replacement
hudson.remoting.Launcher.setPing(boolean)	removed without replacement
hudson.remoting.Launcher.setTcpPortFile(File)	removed without replacement
hudson.remoting.PingThread.onDead()	as of 2.9 Override PingThread.onDead(Throwable) to receive the cause, but also override this method and provide a fallback behaviour to be backward compatible with earlier version of remoting library.
hudson.remoting.Which.jarURL(Class<?>)	Use Which.classFileUrl(Class)
org.jenkinsci.remoting.org.apache.commons.net.util.SubnetUtils.SubnetInfo.getAddressCount()	(3.4) use SubnetUtils.SubnetInfo.getAddressCountLong() instead

Deprecated Constructors

Constructor	Description
hudson.remoting.AbstractByteBufferCommandTransport()	Pass true to AbstractByteBufferCommandTransport(boolean) and switch AbstractByteBufferCommandTransport.write(ByteBuffer, ByteBuffer) to AbstractByteBufferCommandTransport.write(ByteBuffer).
hudson.remoting.Channel(String, ExecutorService, Channel.Mode, InputStream, OutputStream)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withMode(mode) .build(is, os)
hudson.remoting.Channel(String, ExecutorService, Channel.Mode, InputStream, OutputStream, OutputStream)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withMode(mode) .withHeaderStream(header) .withArbitraryCallableAllowed(true) .withRemoteClassLoadingAllowed(true) .build(is, os)
hudson.remoting.Channel(String, ExecutorService, Channel.Mode, InputStream, OutputStream, OutputStream, boolean)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withMode(mode) .withHeaderStream(header) .withArbitraryCallableAllowed(!restricted) .withRemoteClassLoadingAllowed(!restricted) .withBaseLoader(base) .build(is, os)
hudson.remoting.Channel(String, ExecutorService, Channel.Mode, InputStream, OutputStream, OutputStream, boolean, ClassLoader)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withMode(mode) .withHeaderStream(header) .withArbitraryCallableAllowed(!restricted) .withRemoteClassLoadingAllowed(!restricted) .withBaseLoader(base) .build(is, os)
hudson.remoting.Channel(String, ExecutorService, CommandTransport, boolean, ClassLoader)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withArbitraryCallableAllowed(!restricted) .withRemoteClassLoadingAllowed(!restricted) .withBaseLoader(base) .build(transport)
hudson.remoting.Channel(String, ExecutorService, CommandTransport, boolean, ClassLoader, JarCache)	as of 2.38 Use ChannelBuilder ChannelBuilder(name, exec) .withArbitraryCallableAllowed(!restricted) .withRemoteClassLoadingAllowed(!restricted) .withBaseLoader(base) .withJarCache(jarCache) .build(transport)
hudson.remoting.Channel(String, ExecutorService, InputStream, OutputStream)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withMode(Channel.Mode.BINARY) .build(is, os)
hudson.remoting.Channel(String, ExecutorService, InputStream, OutputStream, OutputStream)	as of 2.24 Use ChannelBuilder ChannelBuilder(name, exec) .withMode(Channel.Mode.BINARY) .withHeaderStream(header) .build(is, os)
hudson.remoting.ChannelClosedException()	Use ChannelClosedException(Throwable) or ChannelClosedException(String, Throwable). This constructor will not include cause of the termination.
hudson.remoting.ChannelClosedException(String, Throwable)	Use ChannelClosedException(Channel, String, Throwable)
hudson.remoting.ChannelClosedException(Throwable)	Use ChannelClosedException(Channel, Throwable)
hudson.remoting.FastPipedOutputStream(FastPipedInputStream, int)	as of 1.350 bufferSize parameter is ignored.
hudson.remoting.ObjectInputStreamEx(InputStream, ClassLoader)	as of 2.53
hudson.remoting.RemoteInputStream(InputStream)	as of 2.35 Use RemoteInputStream(InputStream, Flag) and specify either RemoteInputStream.Flag.GREEDY or RemoteInputStream.Flag.NOT_GREEDY.
hudson.remoting.RemoteInputStream(InputStream, boolean)	as of 2.35 Use RemoteInputStream(InputStream, Flag, Flag) with RemoteInputStream.Flag.MANUAL_UNEXPORT. Also specify either RemoteInputStream.Flag.GREEDY or RemoteInputStream.Flag.NOT_GREEDY.
hudson.remoting.SocketInputStream(Socket)	Use SocketChannelStream.in(Socket)
hudson.remoting.SocketOutputStream(Socket)	Use SocketChannelStream.out(Socket)
hudson.remoting.UnexportCommand(int)	Use UnexportCommand(int, Throwable)
org.jenkinsci.remoting.engine.JnlpAgentEndpoint(String, int, RSAPublicKey, Set<String>)	Use JnlpAgentEndpoint(String, int, RSAPublicKey, Set, URL, String)
org.jenkinsci.remoting.engine.JnlpAgentEndpoint(String, int, RSAPublicKey, Set<String>, URL)	Use JnlpAgentEndpoint(String, int, RSAPublicKey, Set, URL, String)