com.maverick.pool

Class SshClientPool

java.lang.Object

com.maverick.pool.SshClientPool

public class SshClientPool
extends Object

A client pool for efficient management of single threaded mode idle connections. This pool ensures that a client is able to respond to server requests for re-keys and keep-alive messages without requiring a dedicated thread-per-client. This currently supports SSH2 clients only.

Constructor Summary

Constructors

Constructor and Description
SshClientPool(ExecutorService executor, SshClientFactory factory)
SshClientPool(ExecutorService executor, SshClientFactory factory, long processingInterval)

Method Summary

Modifier and Type	Method and Description
void	checkin(SshClient client) Check in an idle client.
SshClient	checkout(String host, int port, String username) Check out an available client.
SshClient	checkout(String host, int port, String username, SshClientFactory factory) Check out an available client.
int	getClientCount() Return the total number of clients in the pool
int	getClientCount(String host, int port, String username) Return the total number of clients in the pool for a given host/port/user combination.
protected boolean	processIdle(SshClient client) Process an idle event for the client.
void	setClientSocketTimeout(long clientSocketTimeout) When allowing a client time on its socket, how many milliseconds should the socket timeout be set to.

Methods inherited from class java.lang.Object

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

Constructor Detail

SshClientPool

public SshClientPool(ExecutorService executor,
                     SshClientFactory factory)

Parameters:

executor -

factory -

SshClientPool

public SshClientPool(ExecutorService executor,
                     SshClientFactory factory,
                     long processingInterval)

Parameters:

executor -

factory -

processingInterval -

Method Detail

checkin

public void checkin(SshClient client)

Check in an idle client. The client should not be active, any channels opened should have been closed prior to check in.

Parameters:

client -

checkout

public SshClient checkout(String host,
                          int port,
                          String username)
                   throws SshException,
                          IOException

Check out an available client. If there are no idle clients in the pool, create a new client using the installed SshClientFactory.

Parameters:

host -

port -

username -

Returns:

Throws:

SshException

IOException

checkout

public SshClient checkout(String host,
                          int port,
                          String username,
                          SshClientFactory factory)
                   throws SshException,
                          IOException

Check out an available client. If there are no idle clients in the pool, create a new client using the provided SshClientFactory.

Parameters:

host -

port -

username -

factory -

Returns:

Throws:

SshException

IOException

setClientSocketTimeout

public void setClientSocketTimeout(long clientSocketTimeout)

When allowing a client time on its socket, how many milliseconds should the socket timeout be set to. This should be a low value, the pool task will wait for a timeout on the client before processing the next client in the pool.

Parameters:

clientSocketTimeout - default is 1000ms

processIdle

protected boolean processIdle(SshClient client)

Process an idle event for the client. This calls Ssh2Client

Parameters:

client -

Returns:

getClientCount

public int getClientCount()

Return the total number of clients in the pool

Returns:

getClientCount

public int getClientCount(String host,
                          int port,
                          String username)

Return the total number of clients in the pool for a given host/port/user combination.

Parameters:

host -

port -

username -

Returns: