org.openadaptor.adaptor.standard
Class CommandLineRemoteControl

java.lang.Object
  org.openadaptor.adaptor.AbstractRemoteControl
      org.openadaptor.adaptor.standard.CommandLineRemoteControl

All Implemented Interfaces:

java.lang.Runnable, RemoteControl

public class CommandLineRemoteControl
extends AbstractRemoteControl

Very simple RemoteControl class. It receives input from STDIN and interprets it as control input to the adaptor. Propeties: ========== ControlPassword The Adaptor Password.

Author:

Kevin Scully

Nested Class Summary

class	CommandLineRemoteControl.CommandLine Inner class that implements the behaviour required to parse and execute Adaptor commands.
class	CommandLineRemoteControl.InputListener Inner class whose job is to run provide the thread that listen's on STDIN (System.in) for user input.

Field Summary

protected java.lang.String	hostName
protected CommandLineRemoteControl.InputListener	inputListener
(package private) static org.apache.log4j.Logger	log
protected java.lang.String	logLevel
protected java.lang.String	password
protected java.lang.String	prompt
protected int	refresh
protected java.lang.String	userName

Fields inherited from class org.openadaptor.adaptor.AbstractRemoteControl

_controller, _password

Constructor Summary

CommandLineRemoteControl()

Method Summary

java.lang.String	getControllerName()
java.lang.String	getHostName()
protected java.lang.String	getInput(java.lang.String prompt) get keyboard input, block indefinitely
protected CommandLineRemoteControl.InputListener	getInputListener()
java.lang.String	getLogLevel()
protected java.lang.String	getPrompt()
java.lang.String	getUserName()
void	init(java.util.Properties props, java.lang.String propsPrefix, Controller controller) initialise remote control from properties supports the following properties...
java.lang.String	kill()
java.lang.String	logLevel()
java.lang.String	logLines()
java.lang.String	password(java.lang.String[] args)
java.lang.String	pause()
protected void	printPrompt(java.lang.String prompt)
java.lang.String	resume()
void	run()
protected java.lang.String	sendCommand(java.lang.String command) Construct a DBafControlMessage DO to pass the command along to the Adaptor for processing and pass back the reply.
void	setHostName(java.lang.String newHostName)
protected void	setInputListener(CommandLineRemoteControl.InputListener inputListener)
void	setLogLevel(java.lang.String newLevel)
protected void	setPrompt(java.lang.String prompt)
void	setUserName(java.lang.String newUserName)
protected void	setUserPassword(java.lang.String password)
java.lang.String	status()
java.lang.String	terminate()
java.lang.String	username(java.lang.String[] args)

Methods inherited from class org.openadaptor.adaptor.AbstractRemoteControl

getControlPassword, processRequest, setPassword

Methods inherited from class java.lang.Object

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

Field Detail

log

static org.apache.log4j.Logger log

inputListener

protected CommandLineRemoteControl.InputListener inputListener

hostName

protected java.lang.String hostName

userName

protected java.lang.String userName

password

protected java.lang.String password

logLevel

protected java.lang.String logLevel

refresh

protected int refresh

prompt

protected java.lang.String prompt

Constructor Detail

CommandLineRemoteControl

public CommandLineRemoteControl()

Method Detail

run

public void run()

init

public void init(java.util.Properties props,
                 java.lang.String propsPrefix,
                 Controller controller)
          throws IbafException

Description copied from class: AbstractRemoteControl

initialise remote control from properties supports the following properties... Password control password that request must use

Specified by:

init in interface RemoteControl

Overrides:

init in class AbstractRemoteControl

Throws:

IbafException

setHostName

public void setHostName(java.lang.String newHostName)

getHostName

public java.lang.String getHostName()

setUserName

public void setUserName(java.lang.String newUserName)

getUserName

public java.lang.String getUserName()

getControllerName

public java.lang.String getControllerName()

setUserPassword

protected void setUserPassword(java.lang.String password)

setLogLevel

public void setLogLevel(java.lang.String newLevel)

getLogLevel

public java.lang.String getLogLevel()

logLevel

public java.lang.String logLevel()
                          throws IbafException

Throws:

IbafException

logLines

public java.lang.String logLines()
                          throws IbafException

Throws:

IbafException

pause

public java.lang.String pause()
                       throws IbafException

Throws:

IbafException

resume

public java.lang.String resume()
                        throws IbafException

Throws:

IbafException

terminate

public java.lang.String terminate()
                           throws IbafException

Throws:

IbafException

kill

public java.lang.String kill()
                      throws IbafException

Throws:

IbafException

status

public java.lang.String status()
                        throws IbafException

Throws:

IbafException

password

public java.lang.String password(java.lang.String[] args)

username

public java.lang.String username(java.lang.String[] args)

sendCommand

protected java.lang.String sendCommand(java.lang.String command)
                                throws IbafException

Construct a DBafControlMessage DO to pass the command along to the Adaptor for processing and pass back the reply.

Parameters:

command -

Returns:

Adaptor's Reply

Throws:

IbafException

getInputListener

protected CommandLineRemoteControl.InputListener getInputListener()

setInputListener

protected void setInputListener(CommandLineRemoteControl.InputListener inputListener)

getInput

protected java.lang.String getInput(java.lang.String prompt)

get keyboard input, block indefinitely

printPrompt

protected void printPrompt(java.lang.String prompt)

getPrompt

protected java.lang.String getPrompt()

setPrompt

protected void setPrompt(java.lang.String prompt)