Class ConsoleLineProc

java.lang.Object
  |
  +--org.nukesoft.bot2.lineproc.GenericLineProc
        |
        +--ConsoleLineProc
All Implemented Interfaces:
LineProc, Runnable

public class ConsoleLineProc
extends GenericLineProc
implements Runnable

The ConsoleLineProc provides the ability access a remote console via the bot core. Use this line processor with care as it has the potential to be misused. As a security procaution, this line proc requires a password to load and will lock itself out after three failed attempts in the same dialog session. It can only be unlocked by setting the "locked" tag in the config file to FALSE.

Author:
Ryan Michela

Field Summary
 
Fields inherited from class org.nukesoft.bot2.lineproc.GenericLineProc
context, myCommLibBindID, remoteScreenName
 
Constructor Summary
ConsoleLineProc()
           
 
Method Summary
 void handleIM(IM message)
          Handles the console
 void init(String screenName)
          Loads the line processor and sends the initial greeting.
 void run()
          Scrapes the console screen returning data as it comes.
 void shutdown()
          Kills the console process, if it has been created.
 
Methods inherited from class org.nukesoft.bot2.lineproc.GenericLineProc
bindContext, delay, handleWarn
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConsoleLineProc

public ConsoleLineProc()
Method Detail

init

public void init(String screenName)
Loads the line processor and sends the initial greeting.

Specified by:
init in interface LineProc
Overrides:
init in class GenericLineProc
See Also:
LineProc.init(java.lang.String)

handleIM

public void handleIM(IM message)
Handles the console

Specified by:
handleIM in interface LineProc
Specified by:
handleIM in class GenericLineProc
See Also:
LineProc.handleIM(org.nukesoft.bot2.core.IM)

shutdown

public void shutdown()
Kills the console process, if it has been created.

Specified by:
shutdown in interface LineProc
Overrides:
shutdown in class GenericLineProc
See Also:
LineProc.shutdown()

run

public void run()
Scrapes the console screen returning data as it comes.

Specified by:
run in interface Runnable
See Also:
Runnable.run()