org.apache.sshd.agent.unix

Class UnixAgentFactory

java.lang.Object

org.apache.sshd.agent.unix.UnixAgentFactory

All Implemented Interfaces:

SshAgentFactory, ExecutorServiceCarrier, ExecutorServiceConfigurer

public class UnixAgentFactory
extends Object
implements SshAgentFactory, ExecutorServiceConfigurer

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field and Description
static List<NamedFactory<Channel>>	DEFAULT_FORWARDING_CHANNELS

Fields inherited from interface org.apache.sshd.agent.SshAgentFactory

DEFAULT_PROXY_AUTH_CHANNEL_TYPE, PROXY_AUTH_CHANNEL_TYPE

Constructor Summary

Constructors

Constructor and Description
UnixAgentFactory()
UnixAgentFactory(ExecutorService service, boolean shutdown)

Method Summary

Modifier and Type	Method and 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.
List<NamedFactory<Channel>>	getChannelForwardingFactories(FactoryManager manager) The channels are requested by the ssh server when forwarding a client request.
ExecutorService	getExecutorService()
boolean	isShutdownOnExit()
void	setExecutorService(ExecutorService service)
void	setShutdownOnExit(boolean shutdown)

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<NamedFactory<Channel>> DEFAULT_FORWARDING_CHANNELS

Constructor Detail

UnixAgentFactory

public UnixAgentFactory()

UnixAgentFactory

public UnixAgentFactory(ExecutorService service,
                        boolean shutdown)

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The ExecutorService to use

setExecutorService

public void setExecutorService(ExecutorService service)

Specified by:

setExecutorService in interface ExecutorServiceConfigurer

isShutdownOnExit

public boolean isShutdownOnExit()

Specified by:

isShutdownOnExit in interface ExecutorServiceCarrier

Returns:

If true then the ExecutorService.shutdownNow() will be called (unless it is an internally allocated service which is always closed)

setShutdownOnExit

public void setShutdownOnExit(boolean shutdown)

Specified by:

setShutdownOnExit in interface ExecutorServiceConfigurer

getChannelForwardingFactories

public List<NamedFactory<Channel>> 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 need 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 (named) channel factories used to create channels on the client side

createClient

public SshAgent createClient(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:

manager - The FactoryManager instance

Returns:

The SshAgent instance

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