org.apache.sshd.agent.unix

Class AgentServer

java.lang.Object

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

org.apache.sshd.agent.unix.AgentServer

All Implemented Interfaces:

Closeable, AutoCloseable, ExecutorServiceCarrier

public class AgentServer
extends AbstractLoggingBean
implements Closeable, ExecutorServiceCarrier

A server for an SSH Agent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AgentServer.SshAgentSession

Field Summary

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

log

Constructor Summary

Constructors

Constructor and Description
AgentServer()
AgentServer(ExecutorService executor, boolean shutdownOnExit)
AgentServer(SshAgent agent, ExecutorService executor, boolean shutdownOnExit)

Method Summary

Modifier and Type	Method and Description
void	close()
SshAgent	getAgent()
ExecutorService	getExecutorService()
boolean	isShutdownOnExit()
String	start()

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

Constructor Detail

AgentServer

public AgentServer()

AgentServer

public AgentServer(ExecutorService executor,
                   boolean shutdownOnExit)

AgentServer

public AgentServer(SshAgent agent,
                   ExecutorService executor,
                   boolean shutdownOnExit)

Method Detail

getAgent

public SshAgent getAgent()

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

Returns:

The ExecutorService to use

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)

start

public String start()
             throws Exception

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException