org.myrobotlab.service

Class Cli

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.Cli

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, QueueReporter

public class Cli
extends Service

Cli - This is a command line interface to MyRobotLab. It supports some shell like commands such as "cd", and "ls" Use the command "help" to display help. should be a singleton in a process. This does not seem to work on cygwin/windows, but it does work in a command prompt. Linux/Mac can use this via a Terminal / Console window.

Author:

GroG

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Cli.CliOutputStream
class	Cli.Decoder
class	Cli.Pipe Pipe between another process - its output stream is our input stream its input stream is our output

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cd
static java.lang.String	help
static org.slf4j.Logger	log
static java.lang.String	lp
static java.lang.String	ls
static java.lang.String	pwd
static java.lang.String	question

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
Cli(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String name, java.io.InputStream out, java.io.OutputStream in) add an i/o pair to this cli for the possible purpose attaching this is a remote process's input and output stream, hence from this side they are inverted - ie out is an inputstream and in is an output stream
void	attach()
void	attach(java.lang.String id) Pipe or Attach to another processes' Cli different level cli.attach(process id)
void	attachStdIO()
java.lang.String	cd(java.lang.String path)
void	clear()
void	detach() unfortunate collision of names :( this detach() does not detach from services - but detaches from the std i/o of another process
void	detachStdIO()
java.lang.String	echo(java.lang.String msg)
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getPrompt()
void	ls(java.lang.String path) FIXME !!! return Object[] and let Cli command processor handle encoding for return path is always absolute never relative
static void	main(java.lang.String[] args)
void	process(java.lang.String line) processes input from incoming streams
void	releaseService() Releases resources, and unregisters service from the runtime
void	startService()
java.lang.String	stdout(byte[] data) this method publishes returning data
void	stopService() Stops the service.
void	write(byte[] data)
void	writePrompt()

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, stopHeartbeat, stopMsgRecording, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.slf4j.Logger log

cd

public static final java.lang.String cd

See Also:

Constant Field Values

pwd

public static final java.lang.String pwd

See Also:

Constant Field Values

ls

public static final java.lang.String ls

See Also:

Constant Field Values

lp

public static final java.lang.String lp

See Also:

Constant Field Values

help

public static final java.lang.String help

See Also:

Constant Field Values

question

public static final java.lang.String question

See Also:

Constant Field Values

Constructor Detail

Cli

public Cli(java.lang.String n)

Method Detail

writePrompt

public void writePrompt()
                 throws java.io.IOException

Throws:

java.io.IOException

getPrompt

public java.lang.String getPrompt()

clear

public void clear()

process

public void process(java.lang.String line)
             throws java.io.IOException

processes input from incoming streams

Parameters:

line - - line of data from the stream

Throws:

java.io.IOException - - can throw from damaged io stream

add

public void add(java.lang.String name,
                java.io.InputStream out,
                java.io.OutputStream in)

add an i/o pair to this cli for the possible purpose attaching this is a remote process's input and output stream, hence from this side they are inverted - ie out is an inputstream and in is an output stream

Parameters:

name - - name of pipe

out - - out stream to the remote process

in - - in stream from the remote process

attach

public void attach()

attach

public void attach(java.lang.String id)

Pipe or Attach to another processes' Cli different level cli.attach(process id)

Specified by:

attach in interface Attachable

Overrides:

attach in class Service

Parameters:

id - - service name

attachStdIO

public void attachStdIO()

cd

public java.lang.String cd(java.lang.String path)

detach

public void detach()

unfortunate collision of names :( this detach() does not detach from services - but detaches from the std i/o of another process

Specified by:

detach in interface Attachable

Overrides:

detach in class Service

detachStdIO

public void detachStdIO()

echo

public java.lang.String echo(java.lang.String msg)

ls

public void ls(java.lang.String path)
        throws java.io.IOException

FIXME !!! return Object[] and let Cli command processor handle encoding for return path is always absolute never relative

Parameters:

path - p

Throws:

java.io.IOException - e

write

public void write(byte[] data)
           throws java.io.IOException

Throws:

java.io.IOException

stdout

public java.lang.String stdout(byte[] data)

this method publishes returning data

Parameters:

data - - byte array to be published from stdout stream

Returns:

- the byte array in string form

startService

public void startService()

Specified by:

startService in interface ServiceInterface

Overrides:

startService in class Service

stopService

public void stopService()

Description copied from class: Service

Stops the service. Stops threads.

Specified by:

stopService in interface ServiceInterface

Overrides:

stopService in class Service

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

releaseService

public void releaseService()

Description copied from class: Service

Releases resources, and unregisters service from the runtime

Specified by:

releaseService in interface ServiceInterface

Overrides:

releaseService in class Service

main

public static void main(java.lang.String[] args)