org.neo4j.shell

Interface ShellClient

public interface ShellClient

Represents a shell client which communicates with a ShellServer. A client is very thin, it just grabs a command line from the user and sends it to the server, letting everything happen server-side.

Method Summary

Modifier and Type	Method and Description
void	end() Tells the client session to end, i.e.
void	evaluate(String line) Evaluates a line and reacts to it.
void	evaluate(String line, Output out) Evaluates a line and reacts to it.
Serializable	getId()
Output	getOutput()
String	getPrompt()
ShellServer	getServer()
void	grabPrompt() Grabs the console prompt.
void	setSessionVariable(String key, Serializable value)
void	shutdown() Shuts down any resource needing to shut down.
long	timeForMostRecentConnection()

Method Detail

getId

Serializable getId()

grabPrompt

void grabPrompt()

Grabs the console prompt.

evaluate

void evaluate(String line)
       throws ShellException

Evaluates a line and reacts to it.

Parameters:

line - the line to evaluate.

Throws:

ShellException - if something went wrong.

evaluate

void evaluate(String line,
              Output out)
       throws ShellException

Evaluates a line and reacts to it.

Parameters:

line - the line to evaluate.

out - output just for this evaluation.

Throws:

ShellException - if something went wrong.

end

void end()

Tells the client session to end, i.e. exit the grabPrompt().

getServer

ShellServer getServer()

Returns:

the server to communicate with.

getOutput

Output getOutput()

Returns:

the output instance where output will be passed to.

getPrompt

String getPrompt()

Returns:

the current prompt.

timeForMostRecentConnection

long timeForMostRecentConnection()

Returns:

the time (millis) when the most recent connection was made to the master.

shutdown

void shutdown()

Shuts down any resource needing to shut down.

setSessionVariable

void setSessionVariable(String key,
                        Serializable value)
                 throws ShellException

Throws:

ShellException