Class AgentClient

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.agent.common.AbstractAgentProxy

org.apache.sshd.agent.unix.AgentClient

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, Channel, SshAgent, FactoryManagerHolder, ExecutorServiceCarrier

public class AgentClient
extends AbstractAgentProxy
implements Runnable, FactoryManagerHolder

A client for a remote SSH agent

Field Summary

Fields

Modifier and Type	Field	Description
private final String	authSocket
static final long	DEFAULT_MESSAGE_POLL_FREQUENCY	Default value for "agent-client-message-poll-time"
private final long	handle
private final FactoryManager	manager
static final String	MESSAGE_POLL_FREQUENCY	Time to wait for new incoming messages before checking if the client is still active
private final Queue<Buffer>	messages
private final AtomicBoolean	open
private final long	pool
private Future<?>	pumper
private final Buffer	receiveBuffer

Fields inherited from class AbstractLoggingBean

log

Fields inherited from interface SshAgent

SSH_AUTHSOCKET_ENV_NAME

Constructor Summary

Constructors

Constructor	Description
AgentClient(FactoryManager manager, String authSocket)
AgentClient(FactoryManager manager, String authSocket, CloseableExecutorService executor)

Method Summary

Modifier and Type	Method	Description
void	close()
String	getAuthSocket()
FactoryManager	getFactoryManager()
boolean	isOpen()
protected void	messageReceived(Buffer buffer)
protected Buffer	request(Buffer buffer)
void	run()
protected void	throwException(int code)	transform an APR error number in a more fancy exception
String	toString()
protected Buffer	waitForMessageBuffer()

Methods inherited from class AbstractAgentProxy

addIdentity, createBuffer, createBuffer, getChannelType, getExecutorService, getIdentities, prepare, removeAllIdentities, removeIdentity, setChannelType, sign

Methods inherited from class AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class Object

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

Methods inherited from interface SshAgent

resolveLocalIdentity

Field Details

MESSAGE_POLL_FREQUENCY

public static final String MESSAGE_POLL_FREQUENCY

Time to wait for new incoming messages before checking if the client is still active

See Also:

• Constant Field Values

DEFAULT_MESSAGE_POLL_FREQUENCY

public static final long DEFAULT_MESSAGE_POLL_FREQUENCY

Default value for "agent-client-message-poll-time"

authSocket

private final String authSocket

manager

private final FactoryManager manager

pool

private final long pool

handle

private final long handle

receiveBuffer

private final Buffer receiveBuffer

messages

private final Queue<Buffer> messages

pumper

private Future<?> pumper

open

private final AtomicBoolean open

Constructor Details

AgentClient

public AgentClient(FactoryManager manager,
 String authSocket)
            throws IOException

Throws:

IOException

AgentClient

public AgentClient(FactoryManager manager,
 String authSocket,
 CloseableExecutorService executor)
            throws IOException

Throws:

IOException

Method Details

getFactoryManager

public FactoryManager getFactoryManager()

Specified by:

getFactoryManager in interface FactoryManagerHolder

Returns:

The currently associated FactoryManager

getAuthSocket

public String getAuthSocket()

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

run

public void run()

Specified by:

run in interface Runnable

messageReceived

protected void messageReceived(Buffer buffer)
                        throws Exception

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Overrides:

close in class AbstractAgentProxy

Throws:

IOException

request

protected Buffer request(Buffer buffer)
                  throws IOException

Specified by:

request in class AbstractAgentProxy

Throws:

IOException

waitForMessageBuffer

protected Buffer waitForMessageBuffer()
                               throws IOException

Throws:

IOException

throwException

protected void throwException(int code)
                       throws IOException

transform an APR error number in a more fancy exception

Parameters:

code - APR error code

Throws:

IOException - the produced exception for the given APR error number

toString

public String toString()

Overrides:

toString in class Object