Modifier and Type	Class and Description
private static class	SshdSession.SshdExecProcess
private class	SshdSession.SshdFtpChannel

Modifier and Type	Field and Description
private SshClient	client
private final CopyOnWriteArrayList<SessionCloseListener>	listeners
private static final Logger	LOG
private static final int	MAX_DEPTH
private ClientSession	session
private static final Pattern	SHORT_SSH_FORMAT
private final URIish	uri

Access	Constructor and Description
pack-priv	SshdSession(URIish uri, Supplier<SshClient> clientFactory)

Method Summary

Modifier and Type	Method and Description
public void	addCloseListener(SessionCloseListener to add listener) Adds a `SessionCloseListener` to this session.
private void	close(Closeable toClose, Throwable error)
pack-priv void	connect(Duration timeout)
private ClientSession	connect(URIish target, List<URIish> jumps, SshFutureListener<CloseFuture> listener, Duration timeout, int depth)
private ClientSession	connect(HostConfigEntry config, AttributeRepository context, Duration timeout)
private List<URIish>	determineHops(List<URIish> currentHops, HostConfigEntry hostConfig, String host)
public void	disconnect() Implements org.eclipse.jgit.transport.RemoteSession.disconnect. Disconnects the remote session.
private void	disconnect(Throwable reason)
public Process	exec(String command to execute commandName, int timeout value, in seconds, for creating the remote process timeout) Implements org.eclipse.jgit.transport.RemoteSession.exec. Creates a new remote `Process` to execute the given command.
public Process	exec(String command to execute commandName, Map<String, String> environment variables to pass on environment, int timeout value, in seconds, for creating the remote process timeout) Implements org.eclipse.jgit.transport.RemoteSession2.exec. Creates a new remote `Process` to execute the given command.
public FtpChannel	getFtpChannel() Overrides default org.eclipse.jgit.transport.RemoteSession.getFtpChannel. Obtain an `FtpChannel` to perform SFTP operations in this `SshdSession`.
private HostConfigEntry	getHostConfig(String username, String host, int port)
private void	notifyCloseListeners()
private List<URIish>	parseProxyJump(String proxyJump)
public void	removeCloseListener(SessionCloseListener to remove listener) Removes the given `listener`; has no effect if the listener is not currently registered with this session.
private String	withAuthLog(String message, AuthenticationLogger authLog)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

client	back to summary
private SshClient client

listeners	back to summary
private final CopyOnWriteArrayList<SessionCloseListener> listeners

LOG	back to summary
private static final Logger LOG

MAX_DEPTH	back to summary
private static final int MAX_DEPTH

session	back to summary
private ClientSession session

SHORT_SSH_FORMAT	back to summary
private static final Pattern SHORT_SSH_FORMAT

uri	back to summary
private final URIish uri

SshdSession	back to summary
pack-priv SshdSession(URIish uri, Supplier<SshClient> clientFactory)

Method Detail

addCloseListener back to summary

addCloseListener	back to summary
public void addCloseListener(SessionCloseListener listener) Adds a `SessionCloseListener` to this session. Has no effect if the given `listener` is already registered with this session. Parameters listener:SessionCloseListener to add

public void addCloseListener(SessionCloseListener listener)

Adds a SessionCloseListener to this session. Has no effect if the given listener is already registered with this session.

Parameters

listener:SessionCloseListener: to add

close	back to summary
private void close(Closeable toClose, Throwable error)

connect	back to summary
pack-priv void connect(Duration timeout) throws IOException

connect	back to summary
private ClientSession connect(URIish target, List<URIish> jumps, SshFutureListener<CloseFuture> listener, Duration timeout, int depth) throws IOException

connect	back to summary
private ClientSession connect(HostConfigEntry config, AttributeRepository context, Duration timeout) throws IOException

determineHops	back to summary
private List<URIish> determineHops(List<URIish> currentHops, HostConfigEntry hostConfig, String host) throws IOException

disconnect	back to summary
public void disconnect() Implements org.eclipse.jgit.transport.RemoteSession.disconnect. Doc from org.eclipse.jgit.transport.RemoteSession.disconnect. Disconnects the remote session. Annotations @Override

disconnect

back to summary

public void disconnect()

Implements org.eclipse.jgit.transport.RemoteSession.disconnect.

Doc from org.eclipse.jgit.transport.RemoteSession.disconnect.

Disconnects the remote session.

Annotations

@Override

disconnect	back to summary
private void disconnect(Throwable reason)

exec back to summary

exec	back to summary
public Process exec(String commandName, int timeout) throws IOException Implements org.eclipse.jgit.transport.RemoteSession.exec. Doc from org.eclipse.jgit.transport.RemoteSession.exec. Creates a new remote `Process` to execute the given command. The returned process's streams exist and are connected, and execution of the process is already started. Parameters commandName:String command to execute timeout:int timeout value, in seconds, for creating the remote process Returns:Process a new remote process, already started Annotations @Override Exceptions IOException: may be thrown in several cases. For example, on problems opening input or output streams or on problems connecting or communicating with the remote host. For the latter two cases, a TransportException may be thrown (a subclass of java.io.IOException).

public Process exec(String commandName, int timeout) throws IOException

Implements org.eclipse.jgit.transport.RemoteSession.exec.

Doc from org.eclipse.jgit.transport.RemoteSession.exec.

Creates a new remote Process to execute the given command. The returned process's streams exist and are connected, and execution of the process is already started.

Parameters

commandName:String: command to execute
timeout:int: timeout value, in seconds, for creating the remote process

Returns:Process

a new remote process, already started

Annotations

@Override

Exceptions

IOException:: may be thrown in several cases. For example, on problems opening input or output streams or on problems connecting or communicating with the remote host. For the latter two cases, a TransportException may be thrown (a subclass of java.io.IOException).

exec back to summary

exec	back to summary
public Process exec(String commandName, Map<String, String> environment, int timeout) throws IOException Implements org.eclipse.jgit.transport.RemoteSession2.exec. Doc from org.eclipse.jgit.transport.RemoteSession2.exec. Creates a new remote `Process` to execute the given command. The returned process's streams exist and are connected, and execution of the process is already started. Parameters commandName:String command to execute environment:Map<String, String> environment variables to pass on timeout:int timeout value, in seconds, for creating the remote process Returns:Process a new remote process, already started Annotations @Override Exceptions IOException: may be thrown in several cases. For example, on problems opening input or output streams or on problems connecting or communicating with the remote host. For the latter two cases, a TransportException may be thrown (a subclass of java.io.IOException).

public Process exec(String commandName, Map<String, String> environment, int timeout) throws IOException

Implements org.eclipse.jgit.transport.RemoteSession2.exec.

Doc from org.eclipse.jgit.transport.RemoteSession2.exec.

Creates a new remote Process to execute the given command. The returned process's streams exist and are connected, and execution of the process is already started.

Parameters

commandName:String: command to execute
environment:Map<String, String>: environment variables to pass on
timeout:int: timeout value, in seconds, for creating the remote process

Returns:Process

a new remote process, already started

Annotations

@Override

Exceptions

IOException:: may be thrown in several cases. For example, on problems opening input or output streams or on problems connecting or communicating with the remote host. For the latter two cases, a TransportException may be thrown (a subclass of java.io.IOException).

getFtpChannel back to summary

getFtpChannel	back to summary
public FtpChannel getFtpChannel() Overrides default org.eclipse.jgit.transport.RemoteSession.getFtpChannel. Obtain an `FtpChannel` to perform SFTP operations in this `SshdSession`. Returns:FtpChannel Doc from org.eclipse.jgit.transport.RemoteSession.getFtpChannel. the `FtpChannel` Annotations @Override @NonNull

public FtpChannel getFtpChannel()

Overrides default org.eclipse.jgit.transport.RemoteSession.getFtpChannel.

Obtain an FtpChannel to perform SFTP operations in this SshdSession.

Returns:FtpChannel

Doc from org.eclipse.jgit.transport.RemoteSession.getFtpChannel.

the FtpChannel

Annotations

@Override
@NonNull

getHostConfig	back to summary
private HostConfigEntry getHostConfig(String username, String host, int port) throws IOException

notifyCloseListeners	back to summary
private void notifyCloseListeners()

parseProxyJump	back to summary
private List<URIish> parseProxyJump(String proxyJump) throws URISyntaxException

removeCloseListener back to summary

removeCloseListener	back to summary
public void removeCloseListener(SessionCloseListener listener) Removes the given `listener`; has no effect if the listener is not currently registered with this session. Parameters listener:SessionCloseListener to remove

public void removeCloseListener(SessionCloseListener listener)

Removes the given listener; has no effect if the listener is not currently registered with this session.

Parameters

listener:SessionCloseListener: to remove

withAuthLog	back to summary
private String withAuthLog(String message, AuthenticationLogger authLog)

org.eclipse.jgit.transport.sshd back to summary

private Class SshdSession.SshdExecProcess

Class Inheritance

extends Process

java.lang.Object
java.lang.Process
org.eclipse.jgit.transport.sshd.SshdSession.SshdExecProcess

Field Summary

Modifier and Type	Field and Description
private final ChannelExec	channel
private final String	commandName

Constructor Summary

Access	Constructor and Description
public	SshdExecProcess(ChannelExec channel, String commandName)

Method Summary

Modifier and Type	Method and Description
public void	destroy() Implements abstract java.lang.Process.destroy. Kills the process.
public int	exitValue() Implements abstract java.lang.Process.exitValue. Returns the exit value for the process.
public InputStream	getErrorStream() Implements abstract java.lang.Process.getErrorStream. Returns the input stream connected to the error output of the process.
public InputStream	getInputStream() Implements abstract java.lang.Process.getInputStream. Returns the input stream connected to the normal output of the process.
public OutputStream	getOutputStream() Implements abstract java.lang.Process.getOutputStream. Returns the output stream connected to the normal input of the process.
public int	waitFor() Implements abstract java.lang.Process.waitFor. Causes the current thread to wait, if necessary, until the process represented by this `Process` object has terminated.
public boolean	waitFor(long the maximum time to wait timeout, TimeUnit the time unit of the `timeout` argument unit) Overrides java.lang.Process.waitFor. Causes the current thread to wait, if necessary, until the process represented by this `Process` object has terminated, or the specified waiting time elapses.

Inherited from java.lang.Process:: children descendants destroyForcibly errorReader errorReader info inputReader inputReader isAlive onExit outputWriter outputWriter pid supportsNormalTermination toHandle waitFor

Field Detail

channel	back to summary
private final ChannelExec channel

commandName	back to summary
private final String commandName

Constructor Detail

SshdExecProcess	back to summary
public SshdExecProcess(ChannelExec channel, String commandName)

Method Detail

destroy back to summary

destroy	back to summary
public void destroy() Implements abstract java.lang.Process.destroy. Doc from java.lang.Process.destroy. Kills the process. Whether the process represented by this `Process` object is normally terminated or not is implementation dependent. Forcible process destruction is defined as the immediate termination of a process, whereas normal termination allows the process to shut down cleanly. If the process is not alive, no action is taken. The `java.util.concurrent.CompletableFuture` from `onExit` is completed when the process has terminated. Annotations @Override

public void destroy()

Implements abstract java.lang.Process.destroy.

Doc from java.lang.Process.destroy.

Kills the process. Whether the process represented by this Process object is normally terminated or not is implementation dependent. Forcible process destruction is defined as the immediate termination of a process, whereas normal termination allows the process to shut down cleanly. If the process is not alive, no action is taken.

The java.util.concurrent.CompletableFuture from onExit is completed when the process has terminated.

Annotations

@Override

exitValue back to summary

exitValue	back to summary
public int exitValue() Implements abstract java.lang.Process.exitValue. Doc from java.lang.Process.exitValue. Returns the exit value for the process. Returns:int the exit value of the process represented by this `Process` object. By convention, the value `0` indicates normal termination. Annotations @Override

public int exitValue()

Implements abstract java.lang.Process.exitValue.

Doc from java.lang.Process.exitValue.

Returns the exit value for the process.

Returns:int

the exit value of the process represented by this Process object. By convention, the value 0 indicates normal termination.

Annotations

@Override

getErrorStream back to summary

getErrorStream	back to summary
public InputStream getErrorStream() Implements abstract java.lang.Process.getErrorStream. Doc from java.lang.Process.getErrorStream. Returns the input stream connected to the error output of the process. The stream obtains data piped from the error output of the process represented by this `Process` object. If the standard error of the process has been redirected using `ProcessBuilder.redirectError` or `ProcessBuilder.redirectErrorStream` then this method will return a null input stream. Returns:InputStream the input stream connected to the error output of the process Annotations @Override

public InputStream getErrorStream()

Implements abstract java.lang.Process.getErrorStream.

Doc from java.lang.Process.getErrorStream.

Returns the input stream connected to the error output of the process. The stream obtains data piped from the error output of the process represented by this Process object.

If the standard error of the process has been redirected using ProcessBuilder.redirectError or ProcessBuilder.redirectErrorStream then this method will return a null input stream.

Returns:InputStream

the input stream connected to the error output of the process

Annotations

@Override

getInputStream back to summary

getInputStream	back to summary
public InputStream getInputStream() Implements abstract java.lang.Process.getInputStream. Doc from java.lang.Process.getInputStream. Returns the input stream connected to the normal output of the process. The stream obtains data piped from the standard output of the process represented by this `Process` object. If the standard output of the process has been redirected using `ProcessBuilder.redirectOutput` then this method will return a null input stream. Otherwise, if the standard error of the process has been redirected using `ProcessBuilder.redirectErrorStream` then the input stream returned by this method will receive the merged standard output and the standard error of the process. Returns:InputStream the input stream connected to the normal output of the process Annotations @Override

public InputStream getInputStream()

Implements abstract java.lang.Process.getInputStream.

Doc from java.lang.Process.getInputStream.

Returns the input stream connected to the normal output of the process. The stream obtains data piped from the standard output of the process represented by this Process object.

If the standard output of the process has been redirected using ProcessBuilder.redirectOutput then this method will return a null input stream.

Otherwise, if the standard error of the process has been redirected using ProcessBuilder.redirectErrorStream then the input stream returned by this method will receive the merged standard output and the standard error of the process.

Returns:InputStream

the input stream connected to the normal output of the process

Annotations

@Override

getOutputStream back to summary

getOutputStream	back to summary
public OutputStream getOutputStream() Implements abstract java.lang.Process.getOutputStream. Doc from java.lang.Process.getOutputStream. Returns the output stream connected to the normal input of the process. Output to the stream is piped into the standard input of the process represented by this `Process` object. If the standard input of the process has been redirected using `ProcessBuilder.redirectInput` then this method will return a null output stream. Returns:OutputStream the output stream connected to the normal input of the process Annotations @Override

public OutputStream getOutputStream()

Implements abstract java.lang.Process.getOutputStream.

Doc from java.lang.Process.getOutputStream.

Returns the output stream connected to the normal input of the process. Output to the stream is piped into the standard input of the process represented by this Process object.

If the standard input of the process has been redirected using ProcessBuilder.redirectInput then this method will return a null output stream.

Returns:OutputStream

the output stream connected to the normal input of the process

Annotations

@Override

waitFor back to summary

waitFor	back to summary
public int waitFor() throws InterruptedException Implements abstract java.lang.Process.waitFor. Doc from java.lang.Process.waitFor. Causes the current thread to wait, if necessary, until the process represented by this `Process` object has terminated. This method returns immediately if the process has already terminated. If the process has not yet terminated, the calling thread will be blocked until the process exits. Returns:int the exit value of the process represented by this `Process` object. By convention, the value `0` indicates normal termination. Annotations @Override Exceptions InterruptedException: if the current thread is interrupted by another thread while it is waiting, then the wait is ended and an `InterruptedException` is thrown.

public int waitFor() throws InterruptedException

Implements abstract java.lang.Process.waitFor.

Doc from java.lang.Process.waitFor.

Causes the current thread to wait, if necessary, until the process represented by this Process object has terminated. This method returns immediately if the process has already terminated. If the process has not yet terminated, the calling thread will be blocked until the process exits.

Returns:int

the exit value of the process represented by this Process object. By convention, the value 0 indicates normal termination.

Annotations

@Override

Exceptions

InterruptedException:: if the current thread is interrupted by another thread while it is waiting, then the wait is ended and an InterruptedException is thrown.

waitFor back to summary

waitFor	back to summary
public boolean waitFor(long timeout, TimeUnit unit) throws InterruptedException Overrides java.lang.Process.waitFor. Doc from java.lang.Process.waitFor. Causes the current thread to wait, if necessary, until the process represented by this `Process` object has terminated, or the specified waiting time elapses. If the process has already terminated then this method returns immediately with the value `true`. If the process has not terminated and the timeout value is less than, or equal to, zero, then this method returns immediately with the value `false`. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the `timeout` argument Returns:boolean `true` if the process has exited and `false` if the waiting time elapsed before the process has exited. Annotations @Override Exceptions InterruptedException: if the current thread is interrupted while waiting.

public boolean waitFor(long timeout, TimeUnit unit) throws InterruptedException

Overrides java.lang.Process.waitFor.

Doc from java.lang.Process.waitFor.

Causes the current thread to wait, if necessary, until the process represented by this Process object has terminated, or the specified waiting time elapses.

If the process has already terminated then this method returns immediately with the value true. If the process has not terminated and the timeout value is less than, or equal to, zero, then this method returns immediately with the value false.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:boolean

true if the process has exited and false if the waiting time elapsed before the process has exited.

Annotations

@Override

Exceptions

InterruptedException:: if the current thread is interrupted while waiting.

org.eclipse.jgit.transport.sshd back to summary

private Class SshdSession.SshdFtpChannel

Class Inheritance

extends Object
implements FtpChannel

java.lang.Object
org.eclipse.jgit.transport.sshd.SshdSession.SshdFtpChannel

All Implemented Interfaces

org.eclipse.jgit.transport.FtpChannel

Field Summary

Modifier and Type	Field and Description
private String	cwd Current working directory.
private SftpClient	ftp

Constructor Summary

Access	Constructor and Description
private	SshdFtpChannel()

Method Summary

Modifier and Type	Method and Description
private String	absolute(String path)
public void	cd(String target directory path) Implements org.eclipse.jgit.transport.FtpChannel.cd. Changes the current remote directory.
public void	connect(int for establishing the FTP connection timeout, TimeUnit of the `timeout` unit) Implements org.eclipse.jgit.transport.FtpChannel.connect. Connects the `FtpChannel` to the remote end.
public void	disconnect() Implements org.eclipse.jgit.transport.FtpChannel.disconnect. Disconnects and `FtpChannel`.
public InputStream	get(String of the file to read path) Implements org.eclipse.jgit.transport.FtpChannel.get. Obtain an `InputStream` to read the contents of a remote file.
public boolean	isConnected() Implements org.eclipse.jgit.transport.FtpChannel.isConnected. Whether the FtpChannel is connected
public Collection<FtpChannel.DirEntry>	ls(String of the directory to list path) Implements org.eclipse.jgit.transport.FtpChannel.ls. Lists contents of a remote directory
private <T> T	map(IOFunction<Void, T> op)
public void	mkdir(String to create path) Implements org.eclipse.jgit.transport.FtpChannel.mkdir. Creates a directory on the remote file system.
public OutputStream	put(String of the file to read path) Implements org.eclipse.jgit.transport.FtpChannel.put. Obtain an `OutputStream` to write to a remote file.
public String	pwd() Implements org.eclipse.jgit.transport.FtpChannel.pwd. Get current remote directory path
public void	rename(String original name of the file from, String new name of the file to) Implements org.eclipse.jgit.transport.FtpChannel.rename. Renames a file on the remote file system.
public void	rm(String to delete path) Implements org.eclipse.jgit.transport.FtpChannel.rm. Deletes a file on the remote file system.
public void	rmdir(String to delete path) Implements org.eclipse.jgit.transport.FtpChannel.rmdir. Deletes a directory on the remote file system.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cwd	back to summary
private String cwd Current working directory.

ftp	back to summary
private SftpClient ftp

Constructor Detail

SshdFtpChannel	back to summary
private SshdFtpChannel()

Method Detail

absolute	back to summary
private String absolute(String path)

cd	back to summary
public void cd(String path) throws IOException Implements org.eclipse.jgit.transport.FtpChannel.cd. Doc from org.eclipse.jgit.transport.FtpChannel.cd. Changes the current remote directory. Parameters path:String target directory Annotations @Override Exceptions IOException: if the operation could not be performed remotely

back to summary

public void cd(String path) throws IOException

Implements org.eclipse.jgit.transport.FtpChannel.cd.

Doc from org.eclipse.jgit.transport.FtpChannel.cd.

Changes the current remote directory.

Parameters

path:String: target directory

Annotations

@Override

Exceptions

IOException:: if the operation could not be performed remotely

connect back to summary

connect	back to summary
public void connect(int timeout, TimeUnit unit) throws IOException Implements org.eclipse.jgit.transport.FtpChannel.connect. Doc from org.eclipse.jgit.transport.FtpChannel.connect. Connects the `FtpChannel` to the remote end. Parameters timeout:int for establishing the FTP connection unit:TimeUnit of the `timeout` Annotations @Override Exceptions IOException: if an IO error occurred