com.trilead.ssh2.LocalStreamForwarder Maven / Gradle / Ivy

Go to download

package com.trilead.ssh2;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import com.trilead.ssh2.channel.Channel;
import com.trilead.ssh2.channel.ChannelManager;
import com.trilead.ssh2.channel.LocalAcceptThread;


/**
 * A LocalStreamForwarder forwards an Input- and Outputstream
 * pair via the secure tunnel to another host (which may or may not be identical
 * to the remote SSH-2 server).
 * 
 * @author Christian Plattner, [email protected]
 * @version $Id: LocalStreamForwarder.java,v 1.1 2007/10/15 12:49:56 cplattne Exp $
 */
public class LocalStreamForwarder
{
	ChannelManager cm;

	String host_to_connect;
	int port_to_connect;
	LocalAcceptThread lat;

	Channel cn;

	LocalStreamForwarder(ChannelManager cm, String host_to_connect, int port_to_connect) throws IOException
	{
		this.cm = cm;
		this.host_to_connect = host_to_connect;
		this.port_to_connect = port_to_connect;

		cn = cm.openDirectTCPIPChannel(host_to_connect, port_to_connect, "127.0.0.1", 0);
	}

	/**
	 * @return An InputStream object.
	 * @throws IOException
	 */
	public InputStream getInputStream() throws IOException
	{
		return cn.getStdoutStream();
	}

	/**
	 * Get the OutputStream. Please be aware that the implementation MAY use an
	 * internal buffer. To make sure that the buffered data is sent over the
	 * tunnel, you have to call the flush method of the
	 * OutputStream. To signal EOF, please use the
	 * close method of the OutputStream.
	 * 
	 * @return An OutputStream object.
	 * @throws IOException
	 */
	public OutputStream getOutputStream() throws IOException
	{
		return cn.getStdinStream();
	}

	/**
	 * Close the underlying SSH forwarding channel and free up resources.
	 * You can also use this method to force the shutdown of the underlying
	 * forwarding channel. Pending output (OutputStream not flushed) will NOT
	 * be sent. Pending input (InputStream) can still be read. If the shutdown
	 * operation is already in progress (initiated from either side), then this
	 * call is a no-op.
	 * 
	 * @throws IOException
	 */
	public void close() throws IOException
	{
		cm.closeChannel(cn, "Closed due to user request.", true);
	}
}