org.apache.sshd.agent.unix

Class AgentServerProxy

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.agent.unix.AgentServerProxy

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, SshAgentServer, ExecutorServiceCarrier

public class AgentServerProxy
extends AbstractLoggingBean
implements SshAgentServer, ExecutorServiceCarrier

The server side fake agent, acting as an agent, but actually forwarding the requests to the auth channel on the client side.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_SOCKET_TIMEOUT Property that can be set on the Session in order to control the authentication timeout (millis).
static int	DEFAULT_AUTH_SOCKET_TIMEOUT

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

CHANNEL_OPEN_TIMEOUT_PROP, DEFAULT_CHANNEL_OPEN_TIMEOUT, DEFAULT_PROXY_CHANNEL_TYPE, PROXY_CHANNEL_TYPE

Constructor Summary

Constructors

Constructor and Description
AgentServerProxy(ConnectionService service)
AgentServerProxy(ConnectionService service, ExecutorService executor, boolean shutdownOnExit)

Method Summary

Modifier and Type	Method and Description
void	close()
ExecutorService	getExecutorService()
String	getId()
boolean	isOpen()
boolean	isShutdownOnExit()

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_SOCKET_TIMEOUT

public static final String AUTH_SOCKET_TIMEOUT

Property that can be set on the Session in order to control the authentication timeout (millis). If not specified then DEFAULT_AUTH_SOCKET_TIMEOUT is used

See Also:

Constant Field Values

DEFAULT_AUTH_SOCKET_TIMEOUT

public static final int DEFAULT_AUTH_SOCKET_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

AgentServerProxy

public AgentServerProxy(ConnectionService service)
                 throws IOException

Throws:

IOException

AgentServerProxy

public AgentServerProxy(ConnectionService service,
                        ExecutorService executor,
                        boolean shutdownOnExit)
                 throws IOException

Throws:

IOException

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The ExecutorService to use

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)

getId

public String getId()

Specified by:

getId in interface SshAgentServer

Returns:

Agent server identifier

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Throws:

IOException