org.neo4j.shell.apps.extra

Class Gsh

java.lang.Object

org.neo4j.shell.impl.AbstractApp

org.neo4j.shell.apps.extra.Gsh

All Implemented Interfaces:

App

public class Gsh
extends org.neo4j.shell.impl.AbstractApp

A way to execute groovy scripts from the shell. It doesn't use the groovy classes directly, but instead purely via reflections... This gives the advantage of not being dependent on groovy at compile-time. So if the groovy classes is in the classpath at run-time then groovy scripts can be executed, otherwise it will say that "Groovy isn't available". It has the old style script/argument format of: sh$ gsh --script1 arg1 arg2 arg3 --script2 arg1 arg2 The paths to look for groovy scripts is decided by the environment variable GSH_PATH, also there are some default paths: ".", "script", "src/script".

Constructor Summary

Constructors

Constructor and Description
Gsh()

Method Summary

Modifier and Type	Method and Description
Continuation	execute(AppCommandParser parser, Session session, Output out) The actual code for the application.
String	getDescription()

Methods inherited from class org.neo4j.shell.impl.AbstractApp

completionCandidates, getAvailableOptions, getDescription, getName, getOptionDefinition, getServer, setServer, shutdown, takesOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

Gsh

public Gsh()

Method Detail

execute

public Continuation execute(AppCommandParser parser,
                            Session session,
                            Output out)
                     throws Exception

Description copied from interface: App

The actual code for the application.

Parameters:

parser - holds the options (w/ or w/o values) as well as arguments.

session - the client session (sort of like the environment for the execution).

out - the output channel for the execution, just like System.out.

Returns:

the result of the execution. It is up to the client to interpret this string, one example is that all apps returns null and the "exit" app returns "e" so that the server interprets the "e" as a sign that it should exit.

Throws:

Exception - if the execution fails.

getDescription

public String getDescription()

Specified by:

getDescription in interface App

Overrides:

getDescription in class org.neo4j.shell.impl.AbstractApp

Returns:

a general description of this application.