Apache Mina SSHD 2.15.0 · org.apache.sshd.server.command.AbstractCommandSupport

Modifier and Type	Field and Description
private ExitCallback	callback
protected boolean	cbCalled
private Future<?>	cmdFuture
protected volatile Thread	cmdRunner
private final String	command
private Environment	environment
private OutputStream	err
protected CloseableExecutorService	executorService
private InputStream	in
private OutputStream	out
private ServerSession	serverSession

Modifier and Type

Field and Description

private ExitCallback

callback

protected boolean

cbCalled

private Future<?>

cmdFuture

protected volatile Thread

private final String

private Environment

private OutputStream

protected CloseableExecutorService

executorService

private InputStream

private OutputStream

out

private ServerSession

serverSession

Access	Constructor and Description
protected	AbstractCommandSupport(String command, CloseableExecutorService executorService)

Access

Constructor and Description

protected

AbstractCommandSupport(String command, CloseableExecutorService executorService)

Modifier and Type	Method and Description
public void	destroy(ChannelSession The `ChannelSession` through which the command has been received channel) Implements org.apache.sshd.server.command.CommandLifecycle.destroy. This method is called by the SSH server to destroy the command because the client has disconnected somehow.
public String	getCommand()
public Environment	getEnvironment()
public OutputStream	getErrorStream()
public CloseableExecutorService	getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.
public ExitCallback	getExitCallback()
public InputStream	getInputStream()
public OutputStream	getOutputStream()
public ServerSession	getServerSession() Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession.
public ServerSession	getSession() Implements org.apache.sshd.common.session.SessionHolder.getSession.
protected Future<?>	getStartedCommandFuture()
protected void	onExit(int exitValue)
protected void	onExit(int exitValue, String exitMessage)
public void	setErrorStream(OutputStream The `OutputStream` used by the shell to write its errors err) Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Set the error stream that can be used by the shell to write its errors.
public void	setExitCallback(ExitCallback The `ExitCallback` to call when shell is closed callback) Implements org.apache.sshd.server.command.Command.setExitCallback. Set the callback that the shell has to call when it is closed.
public void	setInputStream(InputStream The `InputStream` used by the shell to read input. in) Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Set the input stream that can be used by the shell to read input.
public void	setOutputStream(OutputStream The `OutputStream` used by the shell to write its output out) Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Set the output stream that can be used by the shell to write its output.
public void	setSession(ServerSession The `ServerSession` in which this shell will be executed. session) Implements org.apache.sshd.server.session.ServerSessionAware.setSession.
public void	start(ChannelSession The `ChannelSession` through which the command has been received channel, Environment The `Environment` env) Implements org.apache.sshd.server.command.CommandLifecycle.start. Starts the command execution.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Modifier and Type

Method and Description

public void

destroy(ChannelSession

The ChannelSession through which the command has been received

channel)

Implements org.apache.sshd.server.command.CommandLifecycle.destroy.

This method is called by the SSH server to destroy the command because the client has disconnected somehow.

public String

getCommand()

public Environment

getEnvironment()

public OutputStream

getErrorStream()

public CloseableExecutorService

getExecutorService()

Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

public ExitCallback

public InputStream

public OutputStream

public ServerSession

Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession.

public ServerSession

getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

protected Future<?>

getStartedCommandFuture()

protected void

onExit(int exitValue)

protected void

onExit(int exitValue, String exitMessage)

public void

setErrorStream(OutputStream

The OutputStream used by the shell to write its errors

err)

Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream.

Set the error stream that can be used by the shell to write its errors.

public void

setExitCallback(ExitCallback

The ExitCallback to call when shell is closed

callback)

Implements org.apache.sshd.server.command.Command.setExitCallback.

Set the callback that the shell has to call when it is closed.

public void

setInputStream(InputStream

The InputStream used by the shell to read input.

in)

Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream.

Set the input stream that can be used by the shell to read input.

public void

setOutputStream(OutputStream

The OutputStream used by the shell to write its output

out)

Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream.

Set the output stream that can be used by the shell to write its output.

public void

setSession(ServerSession

The ServerSession in which this shell will be executed.

session)

Implements org.apache.sshd.server.session.ServerSessionAware.setSession.

public void

start(ChannelSession

The ChannelSession through which the command has been received

channel, Environment

The Environment

env)

Implements org.apache.sshd.server.command.CommandLifecycle.start.

Starts the command execution.

public String

toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

callback	back to summary
private ExitCallback callback

callback

back to summary

private ExitCallback callback

cbCalled	back to summary
protected boolean cbCalled

cbCalled

back to summary

protected boolean cbCalled

cmdFuture	back to summary
private Future<?> cmdFuture

cmdFuture

back to summary

private Future<?> cmdFuture

cmdRunner	back to summary
protected volatile Thread cmdRunner

cmdRunner

back to summary

protected volatile Thread cmdRunner

command	back to summary
private final String command

command

back to summary

private final String command

environment	back to summary
private Environment environment

environment

back to summary

private Environment environment

err	back to summary
private OutputStream err

err

back to summary

private OutputStream err

executorService	back to summary
protected CloseableExecutorService executorService

executorService

back to summary

protected CloseableExecutorService executorService

in	back to summary
private InputStream in

back to summary

private InputStream in

out	back to summary
private OutputStream out

out

back to summary

private OutputStream out

serverSession	back to summary
private ServerSession serverSession

serverSession

back to summary

private ServerSession serverSession

AbstractCommandSupport	back to summary
protected AbstractCommandSupport(String command, CloseableExecutorService executorService)

AbstractCommandSupport

back to summary

protected AbstractCommandSupport(String command, CloseableExecutorService executorService)

Method Detail

destroy back to summary

destroy	back to summary
public void destroy(ChannelSession channel) throws Exception Implements org.apache.sshd.server.command.CommandLifecycle.destroy. Doc from org.apache.sshd.server.command.CommandLifecycle.destroy. This method is called by the SSH server to destroy the command because the client has disconnected somehow. Parameters channel:ChannelSession The `ChannelSession` through which the command has been received Annotations @Override Exceptions Exception: if failed to destroy

public void destroy(ChannelSession channel) throws Exception

Implements org.apache.sshd.server.command.CommandLifecycle.destroy.

Doc from org.apache.sshd.server.command.CommandLifecycle.destroy.

This method is called by the SSH server to destroy the command because the client has disconnected somehow.

Parameters

channel:ChannelSession: The ChannelSession through which the command has been received

Annotations

@Override

Exceptions

Exception:: if failed to destroy

getCommand	back to summary
public String getCommand()

getEnvironment	back to summary
public Environment getEnvironment()

getErrorStream	back to summary
public OutputStream getErrorStream()

getExecutorService back to summary

getExecutorService	back to summary
public CloseableExecutorService getExecutorService() Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. Returns:CloseableExecutorService Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService. The `CloseableExecutorService` to use Annotations @Override

public CloseableExecutorService getExecutorService()

Implements org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

Returns:CloseableExecutorService

Doc from org.apache.sshd.common.util.threads.ExecutorServiceCarrier.getExecutorService.

The CloseableExecutorService to use

Annotations

@Override

getExitCallback	back to summary
public ExitCallback getExitCallback()

getInputStream	back to summary
public InputStream getInputStream()

getOutputStream	back to summary
public OutputStream getOutputStream()

getServerSession back to summary

getServerSession	back to summary
public ServerSession getServerSession() Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession. Returns:ServerSession Doc from org.apache.sshd.server.session.ServerSessionHolder.getServerSession. The underlying `ServerSession` used Annotations @Override

public ServerSession getServerSession()

Implements org.apache.sshd.server.session.ServerSessionHolder.getServerSession.

Returns:ServerSession

Doc from org.apache.sshd.server.session.ServerSessionHolder.getServerSession.

The underlying ServerSession used

Annotations

@Override

getSession	back to summary
public ServerSession getSession() Implements org.apache.sshd.common.session.SessionHolder.getSession. Annotations @Override

getSession

back to summary

public ServerSession getSession()

Implements org.apache.sshd.common.session.SessionHolder.getSession.

Annotations

@Override

getStartedCommandFuture	back to summary
protected Future<?> getStartedCommandFuture()

onExit	back to summary
protected void onExit(int exitValue)

onExit	back to summary
protected void onExit(int exitValue, String exitMessage)

setErrorStream back to summary

setErrorStream	back to summary
public void setErrorStream(OutputStream err) Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Doc from org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream. Set the error stream that can be used by the shell to write its errors. Parameters err:OutputStream The `OutputStream` used by the shell to write its errors Annotations @Override

public void setErrorStream(OutputStream err)

Implements org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream.

Doc from org.apache.sshd.server.command.CommandDirectErrorStreamAware.setErrorStream.

Set the error stream that can be used by the shell to write its errors.

Parameters

err:OutputStream: The OutputStream used by the shell to write its errors

Annotations

@Override

setExitCallback back to summary

setExitCallback	back to summary
public void setExitCallback(ExitCallback callback) Implements org.apache.sshd.server.command.Command.setExitCallback. Doc from org.apache.sshd.server.command.Command.setExitCallback. Set the callback that the shell has to call when it is closed. Parameters callback:ExitCallback The `ExitCallback` to call when shell is closed Annotations @Override

public void setExitCallback(ExitCallback callback)

Implements org.apache.sshd.server.command.Command.setExitCallback.

Doc from org.apache.sshd.server.command.Command.setExitCallback.

Set the callback that the shell has to call when it is closed.

Parameters

callback:ExitCallback: The ExitCallback to call when shell is closed

Annotations

@Override

setInputStream back to summary

setInputStream	back to summary
public void setInputStream(InputStream in) Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Doc from org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream. Set the input stream that can be used by the shell to read input. Parameters in:InputStream The `InputStream` used by the shell to read input. Annotations @Override

public void setInputStream(InputStream in)

Implements org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream.

Doc from org.apache.sshd.server.command.CommandDirectInputStreamAware.setInputStream.

Set the input stream that can be used by the shell to read input.

Parameters

in:InputStream: The InputStream used by the shell to read input.

Annotations

@Override

setOutputStream back to summary

setOutputStream	back to summary
public void setOutputStream(OutputStream out) Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Doc from org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream. Set the output stream that can be used by the shell to write its output. Parameters out:OutputStream The `OutputStream` used by the shell to write its output Annotations @Override

public void setOutputStream(OutputStream out)

Implements org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream.

Doc from org.apache.sshd.server.command.CommandDirectOutputStreamAware.setOutputStream.

Set the output stream that can be used by the shell to write its output.

Parameters

out:OutputStream: The OutputStream used by the shell to write its output

Annotations

@Override

setSession back to summary

setSession	back to summary
public void setSession(ServerSession session) Implements org.apache.sshd.server.session.ServerSessionAware.setSession. Parameters session:ServerSession Doc from org.apache.sshd.server.session.ServerSessionAware.setSession. The `ServerSession` in which this shell will be executed. Annotations @Override

public void setSession(ServerSession session)

Implements org.apache.sshd.server.session.ServerSessionAware.setSession.

Parameters

session:ServerSession

Doc from org.apache.sshd.server.session.ServerSessionAware.setSession.

The ServerSession in which this shell will be executed.

Annotations

@Override

start back to summary

start	back to summary
public void start(ChannelSession channel, Environment env) throws IOException Implements org.apache.sshd.server.command.CommandLifecycle.start. Doc from org.apache.sshd.server.command.CommandLifecycle.start. Starts the command execution. All streams must have been set before calling this method. The command should implement `java.lang.Runnable`, and this method should spawn a new thread like: `Thread(this).start();` Parameters channel:ChannelSession The `ChannelSession` through which the command has been received env:Environment The `Environment` Annotations @Override Exceptions IOException: If failed to start

public void start(ChannelSession channel, Environment env) throws IOException

Implements org.apache.sshd.server.command.CommandLifecycle.start.

Doc from org.apache.sshd.server.command.CommandLifecycle.start.

Starts the command execution. All streams must have been set before calling this method. The command should implement java.lang.Runnable, and this method should spawn a new thread like:

Thread(this).start();

Parameters

channel:ChannelSession: The ChannelSession through which the command has been received
env:Environment: The Environment

Annotations

@Override

Exceptions

IOException:: If failed to start

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

public abstract Class AbstractCommandSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail