Package org.apache.sshd.agent
Interface SshAgentFactory
-
- All Known Implementing Classes:
LocalAgentFactory
,ProxyAgentFactory
,UnixAgentFactory
public interface SshAgentFactory
TheSshAgentFactory
is used to communicate with an SshAgent.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SshAgent
createClient(Session session, FactoryManager manager)
Create an SshAgent that can be used on the client side by the authentication process to send possible keys.SshAgentServer
createServer(ConnectionService service)
Create the server side that will be used by other SSH clients.java.util.List<ChannelFactory>
getChannelForwardingFactories(FactoryManager manager)
The channels are requested by the ssh server when forwarding a client request.
-
-
-
Method Detail
-
getChannelForwardingFactories
java.util.List<ChannelFactory> getChannelForwardingFactories(FactoryManager manager)
The channels are requested by the ssh server when forwarding a client request. The channel will receive agent requests and needs to forward them to the agent, either local or through another proxy.- Parameters:
manager
- TheFactoryManager
through which the request is made- Returns:
- The
ChannelFactory
-ies used to create channels for agent forwarding on the client side. Ifnull
or empty, agent forwarding is not available.
-
createClient
SshAgent createClient(Session session, FactoryManager manager) 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
- theSession
theSshAgent
is to be created for; may benull
manager
- TheFactoryManager
instance- Returns:
- The
SshAgent
instance, ornull
if no SSH agent shall be used - Throws:
java.io.IOException
- If failed to create the client
-
createServer
SshAgentServer createServer(ConnectionService service) 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:
service
- TheConnectionService
to use- Returns:
- The
SshAgentServer
instance - Throws:
java.io.IOException
- If failed to create the server
-
-