Package org.apache.sshd.agent.local

Class LocalAgentFactory

java.lang.Object

org.apache.sshd.agent.local.LocalAgentFactory

All Implemented Interfaces:

SshAgentFactory

public class LocalAgentFactory
extends Object
implements SshAgentFactory

Field Summary

Fields

Modifier and Type	Field	Description
static List<ChannelFactory>	DEFAULT_FORWARDING_CHANNELS

Constructor Summary

Constructors

Constructor	Description
LocalAgentFactory()
LocalAgentFactory(SshAgent agent)

Method Summary

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.
SshAgent	getAgent()
List<ChannelFactory>	getChannelForwardingFactories(FactoryManager manager)	The channels are requested by the ssh server when forwarding a client request.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORWARDING_CHANNELS

public static final List<ChannelFactory> DEFAULT_FORWARDING_CHANNELS

Constructor Detail

LocalAgentFactory

public LocalAgentFactory()

LocalAgentFactory

public LocalAgentFactory(SshAgent agent)

Method Detail

getAgent

public SshAgent getAgent()

getChannelForwardingFactories

public List<ChannelFactory> getChannelForwardingFactories(FactoryManager manager)

Description copied from interface: SshAgentFactory

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.

Specified by:

getChannelForwardingFactories in interface SshAgentFactory

Parameters:

manager - The FactoryManager through which the request is made

Returns:

The ChannelFactory-ies used to create channels for agent forwarding on the client side. If null or empty, agent forwarding is not available.

createClient

public SshAgent createClient(Session session,
                             FactoryManager manager)
                      throws IOException

Description copied from interface: SshAgentFactory

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

Specified by:

createClient in interface SshAgentFactory

Parameters:

session - the Session the SshAgent is to be created for; may be null

manager - The FactoryManager instance

Returns:

The SshAgent instance, or null if no SSH agent shall be used

Throws:

IOException - If failed to create the client

createServer

public SshAgentServer createServer(ConnectionService service)
                            throws IOException

Description copied from interface: SshAgentFactory

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.

Specified by:

createServer in interface SshAgentFactory

Parameters:

service - The ConnectionService to use

Returns:

The SshAgentServer instance

Throws:

IOException - If failed to create the server