org.apache.sshd.agent.common

Class AbstractAgentProxy

java.lang.Object

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

org.apache.sshd.agent.common.AbstractAgentProxy

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, SshAgent, ExecutorServiceCarrier, ExecutorServiceConfigurer

Direct Known Subclasses:

AgentClient

public abstract class AbstractAgentProxy
extends AbstractLoggingBean
implements SshAgent, ExecutorServiceConfigurer

Author:

Apache MINA SSHD Project

Field Summary

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

log

Fields inherited from interface org.apache.sshd.agent.SshAgent

SSH_AUTHSOCKET_ENV_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAgentProxy()

Method Summary

Modifier and Type	Method and Description
void	addIdentity(KeyPair kp, String comment)
void	close()
protected Buffer	createBuffer(byte cmd)
protected Buffer	createBuffer(byte cmd, int extraLen)
ExecutorService	getExecutorService()
List<Pair<PublicKey,String>>	getIdentities()
boolean	isShutdownOnExit()
protected Buffer	prepare(Buffer buffer)
void	removeAllIdentities()
void	removeIdentity(PublicKey key)
protected abstract Buffer	request(Buffer buffer)
void	setExecutorService(ExecutorService service)
void	setShutdownOnExit(boolean shutdown)
byte[]	sign(PublicKey key, byte[] data)

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

Methods inherited from interface java.nio.channels.Channel

isOpen

Constructor Detail

AbstractAgentProxy

protected AbstractAgentProxy()

Method Detail

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The ExecutorService to use

setExecutorService

public void setExecutorService(ExecutorService service)

Specified by:

setExecutorService in interface ExecutorServiceConfigurer

isShutdownOnExit

public boolean isShutdownOnExit()

Specified by:

isShutdownOnExit in interface ExecutorServiceCarrier

Returns:

If true then the ExecutorService.shutdownNow() will be called (unless it is an internally allocated service which is always closed)

setShutdownOnExit

public void setShutdownOnExit(boolean shutdown)

Specified by:

setShutdownOnExit in interface ExecutorServiceConfigurer

getIdentities

public List<Pair<PublicKey,String>> getIdentities()
                                           throws IOException

Specified by:

getIdentities in interface SshAgent

Throws:

IOException

sign

public byte[] sign(PublicKey key,
                   byte[] data)
            throws IOException

Specified by:

sign in interface SshAgent

Throws:

IOException

addIdentity

public void addIdentity(KeyPair kp,
                        String comment)
                 throws IOException

Specified by:

addIdentity in interface SshAgent

Throws:

IOException

removeIdentity

public void removeIdentity(PublicKey key)
                    throws IOException

Specified by:

removeIdentity in interface SshAgent

Throws:

IOException

removeAllIdentities

public void removeAllIdentities()
                         throws IOException

Specified by:

removeAllIdentities in interface SshAgent

Throws:

IOException

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

createBuffer

protected Buffer createBuffer(byte cmd)

createBuffer

protected Buffer createBuffer(byte cmd,
                              int extraLen)

prepare

protected Buffer prepare(Buffer buffer)

request

protected abstract Buffer request(Buffer buffer)
                           throws IOException

Throws:

IOException