com.sshtools.client.KeyboardInteractivePrompt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maverick-synergy-client Show documentation

The client-side implementation for the Maverick Synergy SSH API

The newest version!

package com.sshtools.client;

/*-
 * #%L
 * Client API
 * %%
 * Copyright (C) 2002 - 2024 JADAPTIVE Limited
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

/**
 *  Represents a keyboard-interactive prompt.
 */
public class KeyboardInteractivePrompt {
	private String prompt;
	private String response;
	private boolean echo;

	/**
	 * Creates a new KBIPrompt object.
	 *
	 * @param prompt
	 * @param echo
	 */
	public KeyboardInteractivePrompt(String prompt, boolean echo) {
		this.prompt = prompt;
		this.echo = echo;
	}

	/**
	 * Get the prompt message to display to the user
	 *
	 * @return String
	 */
	public String getPrompt() {
		return prompt;
	}

	/**
	 * true if the user response should be echo'd to the display,
	 * otherwise false.
	 *
	 * @return boolean
	 */
	public boolean echo() {
		return echo;
	}

	/**
	 * Set the user's response for this prompt.
	 *
	 * @param response
	 */
	public void setResponse(String response) {
		this.response = response;
	}

	/**
	 * Get the user's response for this prompt.
	 *
	 * @return String
	 */
	public String getResponse() {
		return response;
	}
}