org.apache.sshd.agent.common

Interface AgentForwardSupport

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Implementing Classes:

DefaultAgentForwardSupport

public interface AgentForwardSupport
extends Closeable

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

Method Summary

Modifier and Type	Method and Description
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.

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

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

Method Detail

initialize

String initialize()
           throws IOException

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.

Returns:

The agent ID

Throws:

IOException - If failed to initialize