Package org.apache.sshd.agent
Interface SshAgentFactory
-
- All Known Implementing Classes:
LocalAgentFactory
,ProxyAgentFactory
public interface SshAgentFactory
TheSshAgentFactory
is used to communicate with an SshAgent.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_PROXY_AUTH_CHANNEL_TYPE
static java.lang.String
PREFER_UNIX_AGENT
static java.lang.String
PROXY_AUTH_CHANNEL_TYPE
Value that can be set in order to control the type of authentication channel being requested when forwarding a PTY session.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SshAgent
createClient(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.
-
-
-
Field Detail
-
PROXY_AUTH_CHANNEL_TYPE
static final java.lang.String PROXY_AUTH_CHANNEL_TYPE
Value that can be set in order to control the type of authentication channel being requested when forwarding a PTY session. If not defined thenDEFAULT_PROXY_AUTH_CHANNEL_TYPE
is used- See Also:
- Constant Field Values
-
DEFAULT_PROXY_AUTH_CHANNEL_TYPE
static final java.lang.String DEFAULT_PROXY_AUTH_CHANNEL_TYPE
- See Also:
- Constant Field Values
-
PREFER_UNIX_AGENT
static final java.lang.String PREFER_UNIX_AGENT
- See Also:
- Constant Field Values
-
-
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 need 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 on the client side
-
createClient
SshAgent createClient(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:
manager
- TheFactoryManager
instance- Returns:
- The
SshAgent
instance - 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
-
-