org.neo4j.shell

Interface ShellServer

All Superinterfaces:

Remote

All Known Subinterfaces:

AppShellServer

All Known Implementing Classes:

org.neo4j.shell.impl.AbstractAppServer, GraphDatabaseShellServer, org.neo4j.shell.impl.SimpleAppServer

public interface ShellServer
extends Remote

A shell server which clients can connect to and send requests (command lines).

Method Summary

Modifier and Type	Method and Description
String[]	getAllAvailableCommands()
String	getName()
Response	interpretLine(Serializable clientID, String line, Output out) Receives a command line (probably from a ShellClient) and reacts to it.
Serializable	interpretVariable(Serializable clientID, String key) Interprets a variable from a client session and returns the interpreted result.
void	leave(Serializable clientID) Notifies this server that the client identified by clientID is about to leave, so any session associated with it will be removed.
void	makeRemotelyAvailable(int port, String name) Makes this server available at localhost for clients to connect to via RMI.
void	makeRemotelyAvailable(String host, int port, String name) Makes this server available at the specific host for clients to connect to via RMI.
void	setSessionVariable(Serializable clientID, String key, Object value) Sets a session property for the session identified by clientID.
void	shutdown() Shuts down the server.
TabCompletion	tabComplete(Serializable clientID, String partOfLine) Tries to complete a half-entered line and returns possible candidates, in the form of a TabCompletion.
void	terminate(Serializable clientID) Marks the client's active transaction as terminated.
Welcome	welcome(Map<String,Serializable> initialSession)

Method Detail

getName

String getName()
        throws RemoteException

Returns:

the name of this server.

Throws:

RemoteException - RMI error.

interpretLine

Response interpretLine(Serializable clientID,
                       String line,
                       Output out)
                throws ShellException,
                       RemoteException

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

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.

RemoteException - RMI error.

interpretVariable

Serializable interpretVariable(Serializable clientID,
                               String key)
                        throws ShellException,
                               RemoteException

Interprets a variable from a client session and returns the interpreted result.

Parameters:

clientID - identifying the client.

key - the variable key. help the interpretation.

Returns:

the interpreted value.

Throws:

ShellException - if some error should occur.

RemoteException - RMI error.

terminate

void terminate(Serializable clientID)
        throws RemoteException

Marks the client's active transaction as terminated.

Parameters:

clientID - identifying the client.

Throws:

RemoteException - RMI error.

welcome

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

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

leave

void leave(Serializable clientID)
    throws RemoteException

Notifies this server that the client identified by clientID is about to leave, so any session associated with it will be removed.

Parameters:

clientID - the ID which identifies the client which is leaving. These IDs are handed out from welcome(Map).

Throws:

RemoteException - RMI error.

shutdown

void shutdown()
       throws RemoteException

Shuts down the server.

Throws:

RemoteException - RMI error.

makeRemotelyAvailable

void makeRemotelyAvailable(int port,
                           String name)
                    throws RemoteException

Makes this server available at localhost for clients to connect to via RMI.

Parameters:

port - the RMI port.

name - the RMI name.

Throws:

RemoteException - RMI error.

makeRemotelyAvailable

void makeRemotelyAvailable(String host,
                           int port,
                           String name)
                    throws RemoteException

Makes this server available at the specific host for clients to connect to via RMI.

Parameters:

host - the host to make this server available at.

port - the RMI port.

name - the RMI name.

Throws:

RemoteException - RMI error.

getAllAvailableCommands

String[] getAllAvailableCommands()
                          throws RemoteException

Returns:

all the available commands one can issue to this server.

Throws:

RemoteException - RMI error.

tabComplete

TabCompletion tabComplete(Serializable clientID,
                          String partOfLine)
                   throws ShellException,
                          RemoteException

Tries to complete a half-entered line and returns possible candidates, in the form of a TabCompletion.

Parameters:

clientID - identifying the client.

partOfLine - the half-entered line to try to complete.

Returns:

a TabCompletion containing the possible candidates for completion.

Throws:

ShellException - if some error should occur.

RemoteException - RMI error.

setSessionVariable

void setSessionVariable(Serializable clientID,
                        String key,
                        Object value)
                 throws RemoteException,
                        ShellException

Sets a session property for the session identified by clientID.

Parameters:

clientID - the client ID to identify the session.

key - the property key.

value - the property value.

Throws:

RemoteException - RMI error.

ShellException - if an error occurs during initialization.