Top Description Fields Constructors Methods
org.apache.sshd.client.channel

public Class ChannelSubsystem

extends ChannelSession
Class Inheritance
Imports
java.io.IOException, java.util.Date, org.apache.sshd.common.SshConstants, org.apache.sshd.common.channel.Channel, org.apache.sshd.common.session.Session, org.apache.sshd.common.util.ValidateUtils, org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.core.CoreModuleProperties
Client channel to run a subsystem
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private final String
subsystem

Inherited from org.apache.sshd.client.channel.ChannelSession:
pumperpumperService

Constructor Summary

AccessConstructor and Description
public
ChannelSubsystem(String
The subsystem name for the channel - never null or empty
subsystem)

Method Summary

Modifier and TypeMethod and Description
protected void
doOpen()

Overrides org.apache.sshd.client.channel.AsyncCapableClientChannel.doOpen.

public final String

Returns:

The subsystem name for the channel - never null or empty
getSubsystem()

The subsystem name

public void
handleFailure()

Overrides org.apache.sshd.common.channel.AbstractChannel.handleFailure.

Implements org.apache.sshd.common.channel.Channel.handleFailure.

Invoked when SSH_MSG_CHANNEL_FAILURE received

public void
handleSuccess()

Overrides org.apache.sshd.common.channel.AbstractChannel.handleSuccess.

Implements org.apache.sshd.common.channel.Channel.handleSuccess.

Invoked when SSH_MSG_CHANNEL_SUCCESS received

public void
onClose(final Runnable run)

public String
toString()

Overrides org.apache.sshd.common.channel.AbstractChannel.toString.

Returns a string representation of the object.

Inherited from org.apache.sshd.client.channel.ChannelSession:
handleInternalRequesthandleXonXoffsendEnvVariablessetEnv

Field Detail

subsystemback to summary
private final String subsystem

Constructor Detail

ChannelSubsystemback to summary
public ChannelSubsystem(String subsystem)
Parameters
subsystem:String

The subsystem name for the channel - never null or empty

Method Detail

doOpenback to summary
protected void doOpen() throws IOException

Overrides org.apache.sshd.client.channel.AsyncCapableClientChannel.doOpen.

Annotations
@Override
getSubsystemback to summary
public final String getSubsystem()

The subsystem name

Returns:String

The subsystem name for the channel - never null or empty

handleFailureback to summary
public void handleFailure() throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleFailure.

Implements org.apache.sshd.common.channel.Channel.handleFailure.

Doc from org.apache.sshd.common.channel.Channel.handleFailure.

Invoked when SSH_MSG_CHANNEL_FAILURE received

Annotations
@Override
Exceptions
IOException:
If failed to handle the message
handleSuccessback to summary
public void handleSuccess() throws IOException

Overrides org.apache.sshd.common.channel.AbstractChannel.handleSuccess.

Implements org.apache.sshd.common.channel.Channel.handleSuccess.

Doc from org.apache.sshd.common.channel.Channel.handleSuccess.

Invoked when SSH_MSG_CHANNEL_SUCCESS received

Annotations
@Override
Exceptions
IOException:
If failed to handle the message
onCloseback to summary
public void onClose(final Runnable run)
toStringback to summary
public String toString()

Overrides org.apache.sshd.common.channel.AbstractChannel.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