org.neo4j.shell.kernel

Class GraphDatabaseShellServer

java.lang.Object

org.neo4j.shell.impl.SimpleAppServer

org.neo4j.shell.impl.AbstractAppServer

org.neo4j.shell.kernel.GraphDatabaseShellServer

All Implemented Interfaces:

Remote, AppShellServer, ShellServer

public class GraphDatabaseShellServer
extends org.neo4j.shell.impl.AbstractAppServer

A ShellServer which contains common methods to use with a graph database service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphDatabaseShellServer.WorkingDirReplacer A BashVariableInterpreter.Replacer for the variable "w"/"W" which returns the current working directory (Bash), i.e.

Field Summary

Fields inherited from class org.neo4j.shell.impl.SimpleAppServer

DEFAULT_NAME, DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
GraphDatabaseShellServer(File path, boolean readOnly, String configFileOrNull)
GraphDatabaseShellServer(org.neo4j.kernel.internal.GraphDatabaseAPI graphDb)
GraphDatabaseShellServer(org.neo4j.kernel.internal.GraphDatabaseAPI graphDb, boolean readOnly)
GraphDatabaseShellServer(org.neo4j.graphdb.factory.GraphDatabaseFactory factory, File path, boolean readOnly, String configFileOrNull)

Method Summary

Modifier and Type	Method and Description
void	bindTransaction(Serializable clientId)
org.neo4j.kernel.internal.GraphDatabaseAPI	getDb()
org.neo4j.kernel.api.Statement	getStatement()
Response	interpretLine(Serializable clientId, String line, Output out) Receives a command line (probably from a ShellClient) and reacts to it.
void	registerTopLevelTransactionInProgress(Serializable clientId)
void	shutdown() Shuts down the server.
void	terminate(Serializable clientId) Marks the client's active transaction as terminated.
void	unbindAndRegisterTransaction(Serializable clientId)
Welcome	welcome(Map<String,Serializable> initialSession)

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

findApp, getAllAvailableCommands, tabComplete

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

getClientSession, getName, interpretVariable, leave, makeRemotelyAvailable, makeRemotelyAvailable, setSessionVariable, tabComplete

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neo4j.shell.ShellServer

getName, interpretVariable, leave, makeRemotelyAvailable, makeRemotelyAvailable, setSessionVariable

Constructor Detail

GraphDatabaseShellServer

public GraphDatabaseShellServer(File path,
                                boolean readOnly,
                                String configFileOrNull)
                         throws RemoteException

Parameters:

path - the path to the directory where the database should be created

readOnly - make the instance read-only

configFileOrNull - path to a configuration file or null

Throws:

RemoteException - if an RMI error occurs.

GraphDatabaseShellServer

public GraphDatabaseShellServer(org.neo4j.graphdb.factory.GraphDatabaseFactory factory,
                                File path,
                                boolean readOnly,
                                String configFileOrNull)
                         throws RemoteException

Throws:

RemoteException

GraphDatabaseShellServer

public GraphDatabaseShellServer(org.neo4j.kernel.internal.GraphDatabaseAPI graphDb)
                         throws RemoteException

Throws:

RemoteException

GraphDatabaseShellServer

public GraphDatabaseShellServer(org.neo4j.kernel.internal.GraphDatabaseAPI graphDb,
                                boolean readOnly)
                         throws RemoteException

Throws:

RemoteException

Method Detail

interpretLine

public Response interpretLine(Serializable clientId,
                              String line,
                              Output out)
                       throws ShellException

Description copied from interface: ShellServer

Receives a command line (probably from a ShellClient) and reacts to it. Output is written to the Output object.

Specified by:

interpretLine in interface ShellServer

Overrides:

interpretLine in class org.neo4j.shell.impl.AbstractAppServer

Parameters:

clientId - identifying the client.

line - the command line to react to.

out - where output should go (like System.out).

Returns:

some result from the execution, it's up to the client to interpret the result, if any. F.ex. "e" could mean that the client should exit, in response to a request "exit".

Throws:

ShellException - if there was an error in the interpretation/execution of the command line.

terminate

public void terminate(Serializable clientId)

Description copied from interface: ShellServer

Marks the client's active transaction as terminated.

Parameters:

clientId - identifying the client.

registerTopLevelTransactionInProgress

public void registerTopLevelTransactionInProgress(Serializable clientId)
                                           throws ShellException

Throws:

ShellException

getStatement

public org.neo4j.kernel.api.Statement getStatement()

unbindAndRegisterTransaction

public void unbindAndRegisterTransaction(Serializable clientId)
                                  throws ShellException

Throws:

ShellException

bindTransaction

public void bindTransaction(Serializable clientId)
                     throws ShellException

Throws:

ShellException

getDb

public org.neo4j.kernel.internal.GraphDatabaseAPI getDb()

Returns:

the GraphDatabaseAPI instance given in the constructor.

shutdown

public void shutdown()
              throws RemoteException

Description copied from interface: ShellServer

Shuts down the server.

Specified by:

shutdown in interface ShellServer

Overrides:

shutdown in class org.neo4j.shell.impl.AbstractAppServer

Throws:

RemoteException - RMI error.

welcome

public Welcome welcome(Map<String,Serializable> initialSession)
                throws RemoteException,
                       ShellException

Specified by:

welcome in interface ShellServer

Overrides:

welcome in class org.neo4j.shell.impl.SimpleAppServer

Parameters:

initialSession - the initial session variables that the client would like to override or add to any initial server session variables.

Returns:

a nice welcome for a client. Typically a client connects and asks for a greeting message to display to the user.

Throws:

RemoteException - RMI error.

ShellException - wraps general errors