org.vngx.jsch.RequestSubsystem Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vngx-jsch Show documentation

**vngx-jsch** (beta) is an updated version of the popular JSch SSH library written in pure Java. It has been updated to Java 6 with all the latest language features and improved code clarity.

The newest version!

/*
 * Copyright (c) 2002-2010 Atsuhiko Yamanaka, JCraft,Inc.  All rights reserved.
 * Copyright (c) 2010-2011 Michael Laudati, N1 Concepts LLC.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The names of the authors may not be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT,
 * INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.vngx.jsch;

/**
 * Implementation of Request for requesting to start a subsystem
 * over the session.
 *
 * RFC 4254 - The Secure Shell
 * (SSH) Connection Protocol
 *
 * @author Atsuhiko Yamanaka
 * @author Michael Laudati
 */
class RequestSubsystem extends Request {

	/** Constant name for subsystem request. */
	static final String SUBSYSTEM_REQUEST = "subsystem";

	/** Subsystem to request to start over session. */
	private String _subsystem = null;


	/**
	 * Sets the subsystem to request.
	 *
	 * @param subsystem
	 */
	void setSubsystem(String subsystem) {
		_subsystem = subsystem;
	}

	@Override
	void request(Session session, Channel channel) throws Exception {
		super.request(session, channel);

		// byte		SSH_MSG_CHANNEL_REQUEST(98)
		// uint32	recipient channel
		// string	request type        // "subsystem"
		// boolean	want reply          // 1
		// string   subsystem			// subsystem value to request
		Buffer buffer = new Buffer(150 + _subsystem.length());
		Packet packet = new Packet(buffer);
		packet.reset();
		buffer.putByte(SSH_MSG_CHANNEL_REQUEST);
		buffer.putInt(channel.getRecipient());
		buffer.putString(SUBSYSTEM_REQUEST);
		buffer.putBoolean(waitForReply());
		buffer.putString(_subsystem);
		write(packet);
	}

}