Top Description Fields Constructors Methods
org.apache.sshd.agent.local

public Class AgentServerProxy

extends AbstractLoggingBean
implements SshAgentServer
Class Inheritance
All Implemented Interfaces
org.apache.sshd.agent.SshAgentServer, java.nio.channels.Channel, java.io.Closeable, java.lang.AutoCloseable
Imports
java.io.IOException, java.util.Objects, .UUID, java.util.concurrent.atomic.AtomicBoolean, org.apache.sshd.agent.SshAgent, .SshAgentServer, org.apache.sshd.common.session.ConnectionService, .Session, org.apache.sshd.common.util.logging.AbstractLoggingBean, org.apache.sshd.core.CoreModuleProperties
The server side fake agent, acting as an agent, but actually forwarding the requests to the auth channel on the client side.

Field Summary

Modifier and TypeField and Description
private final String
id

private final AtomicBoolean
open

private final ConnectionService
service

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:
log

Constructor Summary

AccessConstructor and Description
public
AgentServerProxy(ConnectionService service)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements java.nio.channels.Channel.close.

Closes this channel.

public SshAgent
createClient()

public String
getId()

Implements org.apache.sshd.agent.SshAgentServer.getId.

public boolean
isOpen()

Implements java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:
debugdebugdebugdebugdebugerrorerrorerrorerrorerrorgetSimplifiedLoggerinfoinfowarnwarnwarnwarnwarnwarnwarnwarn

Field Detail

idback to summary
private final String id
openback to summary
private final AtomicBoolean open
serviceback to summary
private final ConnectionService service

Constructor Detail

AgentServerProxyback to summary
public AgentServerProxy(ConnectionService service) throws IOException

Method Detail

closeback to summary
public void close() throws IOException

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations
@Override
Exceptions
IOException:
If an I/O error occurs
createClientback to summary
public SshAgent createClient() throws IOException
getIdback to summary
public String getId()

Implements org.apache.sshd.agent.SshAgentServer.getId.

Returns:String

Doc from org.apache.sshd.agent.SshAgentServer.getId.

Agent server identifier

Annotations
@Override
isOpenback to summary
public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations
@Override