Apache Mina SSHD 2.15.0 · org.apache.sshd.agent.unix.AgentClient

Field Summary

Modifier and Type	Field and Description
private final String	authSocket
public static final long	DEFAULT_MESSAGE_POLL_FREQUENCY Default value for agent-client-message-poll-time
private final long	handle
private final FactoryManager	manager
public static final String	MESSAGE_POLL_FREQUENCY Time to wait for new incoming messages before checking if the client is still active
private final Queue<Buffer>	messages
private final AtomicBoolean	open
private final long	pool
private Future<?>	pumper
private final Buffer	receiveBuffer

Constructor Summary

Access	Constructor and Description
public	AgentClient(FactoryManager manager, String authSocket)
public	AgentClient(FactoryManager manager, String authSocket, CloseableExecutorService executor)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.apache.sshd.agent.common.AbstractAgentProxy.close. Implements java.nio.channels.Channel.close. Closes this channel.
public String	getAuthSocket()
public FactoryManager	getFactoryManager() Implements org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
protected void	messageReceived(Buffer buffer)
protected synchronized Buffer	request(Buffer buffer) Implements abstract org.apache.sshd.agent.common.AbstractAgentProxy.request.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
protected void	throwException(int APR error code code) transform an APR error number in a more fancy exception
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected Buffer	waitForMessageBuffer()

Inherited from org.apache.sshd.agent.common.AbstractAgentProxy:: addIdentity createBuffer createBuffer getChannelType getExecutorService getIdentities prepare removeAllIdentities removeIdentity setChannelType sign

Field Detail

authSocket	back to summary
private final String authSocket

DEFAULT_MESSAGE_POLL_FREQUENCY	back to summary
public static final long DEFAULT_MESSAGE_POLL_FREQUENCY Default value for agent-client-message-poll-time

handle	back to summary
private final long handle

manager	back to summary
private final FactoryManager manager

MESSAGE_POLL_FREQUENCY	back to summary
public static final String MESSAGE_POLL_FREQUENCY Time to wait for new incoming messages before checking if the client is still active

messages	back to summary
private final Queue<Buffer> messages

open	back to summary
private final AtomicBoolean open

pool	back to summary
private final long pool

pumper	back to summary
private Future<?> pumper

receiveBuffer	back to summary
private final Buffer receiveBuffer

Constructor Detail

AgentClient	back to summary
public AgentClient(FactoryManager manager, String authSocket) throws IOException

AgentClient	back to summary
public AgentClient(FactoryManager manager, String authSocket, CloseableExecutorService executor) throws IOException

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides org.apache.sshd.agent.common.AbstractAgentProxy.close. 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

public void close() throws IOException

Overrides org.apache.sshd.agent.common.AbstractAgentProxy.close.

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

getAuthSocket	back to summary
public String getAuthSocket()

getFactoryManager back to summary

getFactoryManager	back to summary
public FactoryManager getFactoryManager() Implements org.apache.sshd.common.FactoryManagerHolder.getFactoryManager. Returns:FactoryManager Doc from org.apache.sshd.common.FactoryManagerHolder.getFactoryManager. The currently associated `FactoryManager` Annotations @Override

public FactoryManager getFactoryManager()

Implements org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.

Returns:FactoryManager

Doc from org.apache.sshd.common.FactoryManagerHolder.getFactoryManager.

The currently associated FactoryManager

Annotations

@Override

isOpen back to summary

isOpen	back 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

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

messageReceived	back to summary
protected void messageReceived(Buffer buffer) throws Exception

request	back to summary
protected synchronized Buffer request(Buffer buffer) throws IOException Implements abstract org.apache.sshd.agent.common.AbstractAgentProxy.request. Annotations @Override

request

back to summary

protected synchronized Buffer request(Buffer buffer) throws IOException

Implements abstract org.apache.sshd.agent.common.AbstractAgentProxy.request.

Annotations

@Override

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

throwException	back to summary
protected void throwException(int code) throws IOException transform an APR error number in a more fancy exception Parameters code:int APR error code Exceptions IOException: the produced exception for the given APR error number

throwException

back to summary

protected void throwException(int code) throws IOException

transform an APR error number in a more fancy exception

Parameters

code:int: APR error code

Exceptions

IOException:: the produced exception for the given APR error number

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

waitForMessageBuffer	back to summary
protected Buffer waitForMessageBuffer() throws IOException

public Class AgentClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail