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

public Class ChannelExec

extends PtyCapableChannelSession
Class Inheritance
Imports
java.io.IOException, java.nio.charset.Charset, .StandardCharsets, java.util.Date, .Map, org.apache.sshd.common.SshConstants, org.apache.sshd.common.channel.Channel, .PtyChannelConfigurationHolder, 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 remote command
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
private final byte[]
cmdBytes

private final String
command

Constructor Summary

AccessConstructor and Description
public
ChannelExec(String command, PtyChannelConfigurationHolder configHolder, Map<String, ?> env)

public
ChannelExec(String command, Charset charset, PtyChannelConfigurationHolder configHolder, Map<String, ?> env)

public
ChannelExec(byte[] command, PtyChannelConfigurationHolder configHolder, Map<String, ?> env)

Method Summary

Modifier and TypeMethod and Description
protected void
doOpen()

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

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

Inherited from org.apache.sshd.client.channel.PtyCapableChannelSession:
doOpenPtygetPtyColumnsgetPtyHeightgetPtyLinesgetPtyModesgetPtyTypegetPtyWidthisAgentForwardingisUsePtyresolvePtyTypesendWindowChangesendWindowChangesetAgentForwardingsetPtyColumnssetPtyHeightsetPtyLinessetPtyModessetPtyTypesetPtyWidthsetupSensibleDefaultPtysetUsePty

Field Detail

cmdBytesback to summary
private final byte[] cmdBytes
commandback to summary
private final String command

Constructor Detail

ChannelExecback to summary
public ChannelExec(String command, PtyChannelConfigurationHolder configHolder, Map<String, ?> env)
ChannelExecback to summary
public ChannelExec(String command, Charset charset, PtyChannelConfigurationHolder configHolder, Map<String, ?> env)
ChannelExecback to summary
public ChannelExec(byte[] command, PtyChannelConfigurationHolder configHolder, Map<String, ?> env)

Method Detail

doOpenback to summary
protected void doOpen() throws IOException

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

Annotations
@Override
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