Class ConsoleInput

java.lang.Object

java.lang.Thread

com.biglybt.ui.console.ConsoleInput

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

MultiUserConsoleInput

public class ConsoleInput
extends Thread

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ConsoleInput.CommandEcho
private class	ConsoleInput.CommandHelp
private class	ConsoleInput.CommandLogging
private static class	ConsoleInput.CommandLogout
private static class	ConsoleInput.CommandQuit
private static class	ConsoleInput.CommandUI
private class	ConsoleInput.RedirectOutputStream

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
File[]	adds
private ILogAlertListener	alertHandler
final Properties	aliases
private static final String	ALIASES_CONFIG_FILE
private final CommandReader	br
private final Map	commands
private final boolean	controlling
final Core	core
private ConsoleInput.RedirectOutputStream	current_ros
private final LinkedList<LogEvent>	errorLogEvents
private final List	helpItems
private ILogEventListener	logHandler
private int	numNewErrorLogEvents
private final Vector	oldcommand
PrintStream	out
private static final List	pluginCommands
protected boolean	running
final List<DownloadManager>	torrents
private final UserProfile	userProfile
private boolean	waitingForInput

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
ConsoleInput(Core core, PrintStream _out)	Simple constructor to allow other components to use the console commands such as "set"
ConsoleInput(String con, Core _core, InputStream _in, PrintStream _out, Boolean _controlling)
ConsoleInput(String con, Core _core, Reader _in, PrintStream _out, Boolean _controlling)	Creates a new instance of ConsoleInput
ConsoleInput(String con, Core _core, Reader _in, PrintStream _out, Boolean _controlling, UserProfile profile)

Method Summary

Modifier and Type	Method	Description
private void	destroyalise()
void	downloadRemoteTorrent(String url)	downloads the remote torrent file.
void	downloadRemoteTorrent(String url, String outputDir)	downloads the remote torrent file.
void	downloadTorrent(String fileName)	downloads a torrent on the local file system to the default save directory
void	downloadTorrent(String filename, String outputDir)	begins the download of the torrent in the specified file, downloading it to the specified output directory.
private File	getAliasesFile()
Core	getCore()
String	getDefaultSaveDirectory()	returns the default directory that torrents should be saved to unless otherwise specified
List<LogEvent>	getErrorLogEvents()
GlobalManager	getGlobalManager()
UserProfile	getUserProfile()
protected void	initialise()
boolean	invokeCommand(String command, List cargs)
private void	loadAliases()	read in the aliases from the alias properties file
void	printconsolehelp()
private void	printconsolehelp(PrintStream os)
void	printwelcome()
private void	quit(boolean finish)
private void	registerAlertHandler()
protected void	registerCommand(IConsoleCommand command)
protected void	registerCommands()	registers the commands available to be executed from this console
private void	registerLogHandler()
static void	registerPluginCommand(Class clazz)	can be used by plugins to register console commands since they may not have access to each ConsoleInput object that is created.
private void	registerPluginCommands()	instantiates each of the plugin commands and registers t
protected void	registerUpdateChecker()
void	run()
void	saveAliases()	writes the aliases back out to the alias file
private void	unregisterAlertHandler()
protected void	unregisterCommand(IConsoleCommand command)
protected void	unregisterCommand(String commandName)
private void	unregisterLogHandler()
static void	unregisterPluginCommand(Class clazz)

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ALIASES_CONFIG_FILE

private static final String ALIASES_CONFIG_FILE

See Also:

• Constant Field Values

core

public final Core core

out

public volatile PrintStream out

current_ros

private ConsoleInput.RedirectOutputStream current_ros

torrents

public final List<DownloadManager> torrents

adds

public File[] adds

br

private final CommandReader br

controlling

private final boolean controlling

running

protected boolean running

oldcommand

private final Vector oldcommand

pluginCommands

private static final List pluginCommands

aliases

public final Properties aliases

commands

private final Map commands

helpItems

private final List helpItems

userProfile

private final UserProfile userProfile

logHandler

private ILogEventListener logHandler

alertHandler

private ILogAlertListener alertHandler

errorLogEvents

private final LinkedList<LogEvent> errorLogEvents

numNewErrorLogEvents

private int numNewErrorLogEvents

waitingForInput

private boolean waitingForInput

Constructor Details

ConsoleInput

public ConsoleInput(String con,
 Core _core,
 Reader _in,
 PrintStream _out,
 Boolean _controlling)

Creates a new instance of ConsoleInput

ConsoleInput

public ConsoleInput(String con,
 Core _core,
 Reader _in,
 PrintStream _out,
 Boolean _controlling,
 UserProfile profile)

ConsoleInput

public ConsoleInput(Core core,
 PrintStream _out)

Simple constructor to allow other components to use the console commands such as "set"

Parameters:

core -

_out -

ConsoleInput

public ConsoleInput(String con,
 Core _core,
 InputStream _in,
 PrintStream _out,
 Boolean _controlling)

Method Details

registerPluginCommand

public static void registerPluginCommand(Class clazz)

can be used by plugins to register console commands since they may not have access to each ConsoleInput object that is created.

unregisterPluginCommand

public static void unregisterPluginCommand(Class clazz)

initialise

protected void initialise()

destroyalise

private void destroyalise()

downloadTorrent

public void downloadTorrent(String filename,
 String outputDir)

begins the download of the torrent in the specified file, downloading it to the specified output directory. We also annotate the download with the current username

Parameters:

filename -

outputDir -

downloadRemoteTorrent

public void downloadRemoteTorrent(String url,
 String outputDir)

downloads the remote torrent file. once we have downloaded the .torrent file, we pass the data to the downloadTorrent() method for further processing

Parameters:

url -

outputDir -

downloadTorrent

public void downloadTorrent(String fileName)

downloads a torrent on the local file system to the default save directory

Parameters:

fileName -

downloadRemoteTorrent

public void downloadRemoteTorrent(String url)

downloads the remote torrent file. once we have downloaded the .torrent file, we pass the data to the downloadTorrent() method for further processing

registerPluginCommands

private void registerPluginCommands()

instantiates each of the plugin commands and registers t

registerLogHandler

private void registerLogHandler()

unregisterLogHandler

private void unregisterLogHandler()

registerAlertHandler

private void registerAlertHandler()

unregisterAlertHandler

private void unregisterAlertHandler()

registerCommands

protected void registerCommands()

registers the commands available to be executed from this console

registerCommand

protected void registerCommand(IConsoleCommand command)

Parameters:

set -

unregisterCommand

protected void unregisterCommand(IConsoleCommand command)

unregisterCommand

protected void unregisterCommand(String commandName)

quit

private void quit(boolean finish)

printwelcome

public void printwelcome()

printconsolehelp

public void printconsolehelp()

printconsolehelp

private void printconsolehelp(PrintStream os)

invokeCommand

public boolean invokeCommand(String command,
 List cargs)

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

getAliasesFile

private File getAliasesFile()

loadAliases

private void loadAliases()
                  throws IOException

read in the aliases from the alias properties file

Throws:

IOException

saveAliases

public void saveAliases()

writes the aliases back out to the alias file

getUserProfile

public UserProfile getUserProfile()

Returns:

Returns the userProfile.

getDefaultSaveDirectory

public String getDefaultSaveDirectory()

returns the default directory that torrents should be saved to unless otherwise specified

Returns:

registerUpdateChecker

protected void registerUpdateChecker()

getCore

public Core getCore()

getGlobalManager

public GlobalManager getGlobalManager()

getErrorLogEvents

public List<LogEvent> getErrorLogEvents()