csbase.sga.ssh

Class SSHClientPool

java.lang.Object

csbase.sga.ssh.SSHClientPool

public class SSHClientPool
extends Object

A simple SSHClient pool that disconnect clients active longer than the maximum lease. Call the method retrieveSSHClient() to retrieve a SSHClient and, after done with it, call the method returnSSHClient(SSHClient) to put the SSHClient back into the pool.

Constructor Summary

Constructors

Constructor and Description
SSHClientPool(String sshHost, int sshPort, String sshUserName, String sshUserPass, String sshUserPrivKey, boolean isTunnelEnable, String sshTunnelHost, int sshTunnelPort, String sshTunnelUser, String sshTunnelPass, String sshTunnelPrivKey, int sshTunnelLocalPort, int sshTunnelLocalPortRange) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected csbase.sshclient.SSHClient	retrieveSSHClient() Retrieves a SSHClient from the pool.
protected void	returnSSHClient(csbase.sshclient.SSHClient sshClient) Returns a SSHClient to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSHClientPool

public SSHClientPool(String sshHost,
             int sshPort,
             String sshUserName,
             String sshUserPass,
             String sshUserPrivKey,
             boolean isTunnelEnable,
             String sshTunnelHost,
             int sshTunnelPort,
             String sshTunnelUser,
             String sshTunnelPass,
             String sshTunnelPrivKey,
             int sshTunnelLocalPort,
             int sshTunnelLocalPortRange)

Constructor.

Parameters:

sshHost - host

sshPort - port

sshUserName - username

sshUserPass - password (optional if sshUserPrivKey is provided)

sshUserPrivKey - private key (optional if sshUserPass is provided)

isTunnelEnable - to indicate that a tunnel must be created

sshTunnelHost - host of the tunnel

sshTunnelPort - port of the tunnel

sshTunnelUser - username of the tunnel

sshTunnelPass - password of the tunnel (optional if sshTunnelPrivKey is provided)

sshTunnelPrivKey - private key of the tunnel (optional if sshTunnelPass is provided)

sshTunnelLocalPort - local port of the tunnel

sshTunnelLocalPortRange - local port range of the tunnel

Method Detail

retrieveSSHClient

protected csbase.sshclient.SSHClient retrieveSSHClient()
                                                throws csbase.sshclient.SSHClientException

Retrieves a SSHClient from the pool. If no one is available a new one is created.

Returns:

a SSHClient

Throws:

csbase.sshclient.SSHClientException - if there is a error creating a new SSHClient

returnSSHClient

protected void returnSSHClient(csbase.sshclient.SSHClient sshClient)

Returns a SSHClient to the pool.

Parameters:

sshClient - the SSHClient returned