Top Description Inners Fields Constructors Methods

org.apache.sshd.common.forward

public Class TcpipClientChannel

Class Inheritance

extends AbstractClientChannel
implements ForwardingTunnelEndpointsProvider

All Implemented Interfaces

org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider

Imports

java.io.IOException, java.net.InetSocketAddress, java.util.Collections, .EnumSet, .Objects, .Set, org.apache.sshd.client.channel.AbstractClientChannel, org.apache.sshd.client.future.DefaultOpenFuture, .OpenFuture, org.apache.sshd.common.Closeable, .NamedResource, .SshConstants, .SshException, org.apache.sshd.common.channel.ChannelAsyncInputStream, .ChannelAsyncOutputStream, .ChannelOutputStream, .LocalWindow, org.apache.sshd.common.future.CloseFuture, .DefaultCloseFuture, org.apache.sshd.common.io.IoSession, .IoWriteFuture, org.apache.sshd.common.session.Session, org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.common.util.net.SshdSocketAddress

TODO Add javadoc

Author: Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	TcpipClientChannel.Type Type of channel being created.

Field Summary

Modifier and Type	Field and Description
protected SshdSocketAddress	localEntry
protected final ChannelToPortHandler	port
protected final SshdSocketAddress	remote
private SshdSocketAddress	tunnelEntrance
private SshdSocketAddress	tunnelExit
private final TcpipClientChannel.Type	typeEnum

Inherited from org.apache.sshd.client.channel.AbstractClientChannel:: asyncErr asyncIn asyncOut err exitSignalHolder exitStatusHolder in invertedErr invertedIn invertedOut opened openFailureLang openFailureMsg openFailureReason openFuture out redirectErrorStream streaming

Constructor Summary

Access	Constructor and Description
public	TcpipClientChannel(TcpipClientChannel.Type type, IoSession serverSession, SshdSocketAddress remote)

Method Summary

Modifier and Type	Method and Description
protected ChannelToPortHandler	createChannelToPortHandler(IoSession session)
protected synchronized void	doOpen() Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen.
protected void	doWriteData(byte[] data, int off, long len) Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteData.
protected void	doWriteExtendedData(byte[] data, int off, long len) Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData.
protected Closeable	getInnerCloseable() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable.
public TcpipClientChannel.Type	getTcpipChannelType()
public SshdSocketAddress	getTunnelEntrance() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelEntrance.
public SshdSocketAddress	getTunnelExit() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelExit.
public void	handleEof() Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof. Implements org.apache.sshd.common.channel.Channel.handleEof. Invoked when `SSH_MSG_CHANNEL_EOF` received
public synchronized OpenFuture	open() Overrides org.apache.sshd.client.channel.AbstractClientChannel.open. Implements org.apache.sshd.client.channel.ClientChannel.open.
public void	updateLocalForwardingEntry(LocalForwardingEntry entry)

Field Detail

localEntry	back to summary
protected SshdSocketAddress localEntry

port	back to summary
protected final ChannelToPortHandler port

remote	back to summary
protected final SshdSocketAddress remote

tunnelEntrance	back to summary
private SshdSocketAddress tunnelEntrance

tunnelExit	back to summary
private SshdSocketAddress tunnelExit

typeEnum	back to summary
private final TcpipClientChannel.Type typeEnum

Constructor Detail

TcpipClientChannel	back to summary
public TcpipClientChannel(TcpipClientChannel.Type type, IoSession serverSession, SshdSocketAddress remote)

Method Detail

createChannelToPortHandler	back to summary
protected ChannelToPortHandler createChannelToPortHandler(IoSession session)

doOpen	back to summary
protected synchronized void doOpen() throws IOException Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen. Annotations @Override

doOpen

back to summary

protected synchronized void doOpen() throws IOException

Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen.

Annotations

@Override

doWriteData	back to summary
protected void doWriteData(byte[] data, int off, long len) throws IOException Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteData. Annotations @Override

doWriteData

back to summary

protected void doWriteData(byte[] data, int off, long len) throws IOException

Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteData.

Annotations

@Override

doWriteExtendedData	back to summary
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData. Annotations @Override

doWriteExtendedData

back to summary

protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException

Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData.

Annotations

@Override

getInnerCloseable	back to summary
protected Closeable getInnerCloseable() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable. Annotations @Override

getInnerCloseable

back to summary

protected Closeable getInnerCloseable()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable.

Annotations

@Override

getTcpipChannelType	back to summary
public TcpipClientChannel.Type getTcpipChannelType()

getTunnelEntrance	back to summary
public SshdSocketAddress getTunnelEntrance() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelEntrance. Annotations @Override

getTunnelEntrance

back to summary

public SshdSocketAddress getTunnelEntrance()

Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelEntrance.

Annotations

@Override

getTunnelExit	back to summary
public SshdSocketAddress getTunnelExit() Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelExit. Annotations @Override

getTunnelExit

back to summary

public SshdSocketAddress getTunnelExit()

Implements org.apache.sshd.common.forward.ForwardingTunnelEndpointsProvider.getTunnelExit.

Annotations

@Override

handleEof back to summary

handleEof	back to summary
public void handleEof() throws IOException Overrides org.apache.sshd.common.channel.AbstractChannel.handleEof. Implements org.apache.sshd.common.channel.Channel.handleEof. Doc from org.apache.sshd.common.channel.Channel.handleEof. Invoked when `SSH_MSG_CHANNEL_EOF` received Annotations @Override Exceptions IOException: If failed to handle the message

public void handleEof() throws IOException

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

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

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

Invoked when SSH_MSG_CHANNEL_EOF received

Annotations

@Override

Exceptions

IOException:: If failed to handle the message

open	back to summary
public synchronized OpenFuture open() throws IOException Overrides org.apache.sshd.client.channel.AbstractClientChannel.open. Implements org.apache.sshd.client.channel.ClientChannel.open. Annotations @Override

open

back to summary

public synchronized OpenFuture open() throws IOException

Overrides org.apache.sshd.client.channel.AbstractClientChannel.open.

Implements org.apache.sshd.client.channel.ClientChannel.open.

Annotations

@Override

updateLocalForwardingEntry	back to summary
public void updateLocalForwardingEntry(LocalForwardingEntry entry)

org.apache.sshd.common.forward back to summary

public final Enum TcpipClientChannel.Type

Class Inheritance

extends Enum<TcpipClientChannel.Type>
implements NamedResource

java.lang.Object
java.lang.Enum
org.apache.sshd.common.forward.TcpipClientChannel.Type

All Implemented Interfaces

org.apache.sshd.common.NamedResource

Type of channel being created. The type's getName() method returns the SSH request type

Field Summary

Modifier and Type	Field and Description
private final String	channelType
public static final TcpipClientChannel.Type	Direct
public static final TcpipClientChannel.Type	Forwarded
public static final Set<TcpipClientChannel.Type>	VALUES

Constructor Summary

Access	Constructor and Description
private	Type(String channelType)

Method Summary

Modifier and Type	Method and Description
public String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public static TcpipClientChannel.Type	valueOf(String name)
public static TcpipClientChannel.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

channelType	back to summary
private final String channelType

Direct	back to summary
public static final TcpipClientChannel.Type Direct

Forwarded	back to summary
public static final TcpipClientChannel.Type Forwarded

VALUES	back to summary
public static final Set<TcpipClientChannel.Type> VALUES

Constructor Detail

Type	back to summary
private Type(String channelType)

Method Detail

getName	back to summary
public String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

valueOf	back to summary
public static TcpipClientChannel.Type valueOf(String name)

values	back to summary
public static TcpipClientChannel.Type[] values()