Apache Mina SSHD 2.15.0 · org.apache.sshd.agent.local.LocalAgentFactory

Modifier and Type	Field and Description
private final SshAgent	agent
public static final List<ChannelFactory>	DEFAULT_FORWARDING_CHANNELS

Access	Constructor and Description
public	LocalAgentFactory()
public	LocalAgentFactory(SshAgent agent)

Method Summary

Modifier and Type	Method and Description
public SshAgent	createClient(Session the `Session` the `SshAgent` is to be created for; may be `null` session, FactoryManager The `FactoryManager` instance manager) Implements org.apache.sshd.agent.SshAgentFactory.createClient. Create an SshAgent that can be used on the client side by the authentication process to send possible keys.
public SshAgentServer	createServer(ConnectionService The `ConnectionService` to use service) Implements org.apache.sshd.agent.SshAgentFactory.createServer. Create the server side that will be used by other SSH clients.
public SshAgent	getAgent()
public List<ChannelFactory>	getChannelForwardingFactories(FactoryManager The `FactoryManager` through which the request is made manager) Implements org.apache.sshd.agent.SshAgentFactory.getChannelForwardingFactories. The channels are requested by the ssh server when forwarding a client request.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

agent	back to summary
private final SshAgent agent

DEFAULT_FORWARDING_CHANNELS	back to summary
public static final List<ChannelFactory> DEFAULT_FORWARDING_CHANNELS

LocalAgentFactory	back to summary
public LocalAgentFactory()

LocalAgentFactory	back to summary
public LocalAgentFactory(SshAgent agent)

Method Detail

createClient back to summary

createClient	back to summary
public SshAgent createClient(Session session, FactoryManager manager) throws IOException Implements org.apache.sshd.agent.SshAgentFactory.createClient. Doc from org.apache.sshd.agent.SshAgentFactory.createClient. Create an SshAgent that can be used on the client side by the authentication process to send possible keys. Parameters session:Session the `Session` the `SshAgent` is to be created for; may be `null` manager:FactoryManager The `FactoryManager` instance Returns:SshAgent The `SshAgent` instance, or `null` if no SSH agent shall be used Annotations @Override Exceptions IOException: If failed to create the client

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

Implements org.apache.sshd.agent.SshAgentFactory.createClient.

Doc from org.apache.sshd.agent.SshAgentFactory.createClient.

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

Parameters

session:Session: the Session the SshAgent is to be created for; may be null
manager:FactoryManager: The FactoryManager instance

Returns:SshAgent

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

Annotations

@Override

Exceptions

IOException:: If failed to create the client

createServer back to summary

createServer	back to summary
public SshAgentServer createServer(ConnectionService service) throws IOException Implements org.apache.sshd.agent.SshAgentFactory.createServer. Doc from org.apache.sshd.agent.SshAgentFactory.createServer. 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:ConnectionService The `ConnectionService` to use Returns:SshAgentServer The `SshAgentServer` instance Annotations @Override Exceptions IOException: If failed to create the server

public SshAgentServer createServer(ConnectionService service) throws IOException

Implements org.apache.sshd.agent.SshAgentFactory.createServer.

Doc from org.apache.sshd.agent.SshAgentFactory.createServer.

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:ConnectionService: The ConnectionService to use

Returns:SshAgentServer

The SshAgentServer instance

Annotations

@Override

Exceptions

IOException:: If failed to create the server

getAgent	back to summary
public SshAgent getAgent()

getChannelForwardingFactories back to summary

getChannelForwardingFactories	back to summary
public List<ChannelFactory> getChannelForwardingFactories(FactoryManager manager) Implements org.apache.sshd.agent.SshAgentFactory.getChannelForwardingFactories. Doc from org.apache.sshd.agent.SshAgentFactory.getChannelForwardingFactories. 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:FactoryManager The `FactoryManager` through which the request is made Returns:List<ChannelFactory> The `ChannelFactory`-ies used to create channels for agent forwarding on the client side. If `null` or empty, agent forwarding is not available. Annotations @Override

public List<ChannelFactory> getChannelForwardingFactories(FactoryManager manager)

Implements org.apache.sshd.agent.SshAgentFactory.getChannelForwardingFactories.

Doc from org.apache.sshd.agent.SshAgentFactory.getChannelForwardingFactories.

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:FactoryManager: The FactoryManager through which the request is made

Returns:List<ChannelFactory>

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

Annotations

@Override

public Class LocalAgentFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail