Top Description Methods
org.apache.sshd.agent.common

public Interface AgentForwardSupport

extends Closeable
Known Direct Implementers
org.apache.sshd.agent.common.DefaultAgentForwardSupport
Imports
java.io.IOException, org.apache.sshd.common.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 TypeMethod and Description
public String

Returns:

The agent ID
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.

Inherited from org.apache.sshd.common.Closeable:
addCloseFutureListenerclosecloseclosegetMaxCloseWaitTimeisClosedisClosingisOpenremoveCloseFutureListener

Method Detail

initializeback to summary
public 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:String

The agent ID

Exceptions
IOException:
If failed to initialize