Apache Mina SSHD 2.15.0 · org.apache.sshd.server.shell.UnknownCommand

Modifier and Type	Field and Description
private ExitCallback	callback
private final String	command
private OutputStream	err
private InputStream	in
private final String	message
private OutputStream	out

Access	Constructor and Description
public	UnknownCommand(String command)

Method Summary

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 boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getCommand()
public String	getMessage()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
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	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.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

callback	back to summary
private ExitCallback callback

command	back to summary
private final String command

err	back to summary
private OutputStream err

in	back to summary
private InputStream in Annotations @SuppressWarnings:unused

message	back to summary
private final String message

out	back to summary
private OutputStream out Annotations @SuppressWarnings:unused

UnknownCommand	back to summary
public UnknownCommand(String command)

Method Detail

destroy back to summary

destroy	back to summary
public void destroy(ChannelSession channel) 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

public void destroy(ChannelSession channel)

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

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getCommand	back to summary
public String getCommand()

getMessage	back to summary
public String getMessage()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

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

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

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 Class UnknownCommand

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail