org.apache.sshd.agent.common

Class DefaultAgentForwardSupport

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.agent.common.DefaultAgentForwardSupport

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, AgentForwardSupport

public class DefaultAgentForwardSupport
extends AbstractCloseable
implements AgentForwardSupport

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Field Summary

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, lock, state

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

log

Fields inherited from interface org.apache.sshd.common.Closeable

CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
DefaultAgentForwardSupport(ConnectionService service)

Method Summary

Modifier and Type	Method and Description
void	close()
protected SshAgentServer	createSshAgentServer(ConnectionService service, Session session)
protected void	doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
String	initialize() Initializes the agent forwarding if not already done so - i.e., can be called more than once - only first successful call counts, the rest will return the identifier of the previously initialized agent.
String	toString()

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, doCloseGracefully, isClosed, isClosing, preClose, removeCloseFutureListener

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, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Constructor Detail

DefaultAgentForwardSupport

public DefaultAgentForwardSupport(ConnectionService service)

Method Detail

initialize

public String initialize()
                  throws IOException

Description copied from interface: AgentForwardSupport

Initializes the agent forwarding if not already done so - i.e., can be called more than once - only first successful call counts, the rest will return the identifier of the previously initialized agent.

Specified by:

initialize in interface AgentForwardSupport

Returns:

The agent ID

Throws:

IOException - If failed to initialize

createSshAgentServer

protected SshAgentServer createSshAgentServer(ConnectionService service,
                                              Session session)
                                       throws Throwable

Throws:

Throwable

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

doCloseImmediately

protected void doCloseImmediately()

Description copied from class: AbstractCloseable

doCloseImmediately is called once and only once with state == Immediate

Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing

Overrides:

doCloseImmediately in class AbstractCloseable

toString

public String toString()

Overrides:

toString in class Object