org.eclipse.jgit.transport.sshd

Class SshdSession

java.lang.Object

org.eclipse.jgit.transport.sshd.SshdSession

All Implemented Interfaces:

RemoteSession

public class SshdSession
extends Object
implements RemoteSession

An implementation of RemoteSession based on Apache MINA sshd.

Since:

5.2

Method Summary

Modifier and Type	Method and Description
void	addCloseListener(SessionCloseListener listener) Adds a SessionCloseListener to this session.
void	disconnect() Disconnect the remote session
Process	exec(String commandName, int timeout) Generate a new remote process to execute the given command.
FtpChannel	getFtpChannel() Obtain an FtpChannel to perform SFTP operations in this SshdSession.
void	removeCloseListener(SessionCloseListener listener) Removes the given listener; has no effect if the listener is not currently registered with this session.

Methods inherited from class java.lang.Object

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

Method Detail

addCloseListener

public void addCloseListener(@NonNull
                             SessionCloseListener listener)

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

Parameters:

listener - to add

removeCloseListener

public void removeCloseListener(@NonNull
                                SessionCloseListener listener)

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

Parameters:

listener - to remove

exec

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

Description copied from interface: RemoteSession

Generate a new remote process to execute the given command. This function should also start execution and may need to create the streams prior to execution.

Specified by:

exec in interface RemoteSession

Parameters:

commandName - command to execute

timeout - timeout value, in seconds, for command execution

Returns:

a new remote process

Throws:

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

@NonNull
public FtpChannel getFtpChannel()

Obtain an FtpChannel to perform SFTP operations in this SshdSession.

Specified by:

getFtpChannel in interface RemoteSession

Returns:

the FtpChannel

disconnect

public void disconnect()

Description copied from interface: RemoteSession

Disconnect the remote session

Specified by:

disconnect in interface RemoteSession