org.apache.sshd.agent
Interface SshAgentFactory

All Known Implementing Classes:

LocalAgentFactory, ProxyAgentFactory, UnixAgentFactory

public interface SshAgentFactory

The SshAgentFactory is used to communicate with an SshAgent.

Method Summary

SshAgent	createClient(Session session) Create an SshAgent that can be used on the client side by the authentication process to send possible keys.
SshAgentServer	createServer(Session session) Create the server side that will be used by other SSH clients.
NamedFactory<Channel>	getChannelForwardingFactory() Retrieve the channel factory used to create channels on the client side.

Method Detail

getChannelForwardingFactory

NamedFactory<Channel> getChannelForwardingFactory()

Retrieve the channel factory used to create channels on the client side. The channels are requested by the ssh server when forwarding a client request. The channel will receive agent requests and need to forward them to the agent, either local or through another proxy.

Returns:

createClient

SshAgent createClient(Session session)
                      throws java.io.IOException

Create an SshAgent that can be used on the client side by the authentication process to send possible keys.

Parameters:

session -

Returns:

Throws:

java.io.IOException

createServer

SshAgentServer createServer(Session session)
                            throws java.io.IOException

Create the server side that will be used by other SSH clients. It will usually create a channel that will forward the requests to the original client.

Parameters:

session -

Returns:

Throws:

java.io.IOException