org.neo4j.shell

Class ShellLobby

java.lang.Object

org.neo4j.shell.ShellLobby

public abstract class ShellLobby
extends Object

A convenience class for creating servers clients as well as finding remote servers.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,Serializable>	NO_INITIAL_SESSION

Constructor Summary

Constructors

Constructor and Description
ShellLobby()

Method Summary

Modifier and Type	Method and Description
static ShellClient	newClient() Creates a client and "starts" it, i.e.
static ShellClient	newClient(int port) Creates a client and "starts" it, i.e.
static ShellClient	newClient(int port, String name, CtrlCHandler ctrlcHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(org.neo4j.shell.impl.RmiLocation serverLocation, CtrlCHandler ctrlcHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(org.neo4j.shell.impl.RmiLocation serverLocation, Map<String,Serializable> initialSession, CtrlCHandler ctrlcHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(ShellServer server) Creates a client and "starts" it, i.e.
static ShellClient	newClient(ShellServer server, CtrlCHandler signalHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(ShellServer server, Map<String,Serializable> initialSession, CtrlCHandler signalHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(ShellServer server, Map<String,Serializable> initialSession, Output output, CtrlCHandler signalHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(String host, CtrlCHandler ctrlcHandler) Creates a client and "starts" it, i.e.
static ShellClient	newClient(String host, int port) Creates a client and "starts" it, i.e.
static ShellClient	newClient(String host, int port, String name, CtrlCHandler ctrlcHandler) Creates a client and "starts" it, i.e.
static ShellServer	newServer(Class<? extends ShellServer> cls) To get rid of the RemoteException, uses a constructor without arguments.
static org.neo4j.shell.impl.RmiLocation	remoteLocation()
static org.neo4j.shell.impl.RmiLocation	remoteLocation(int port)
static org.neo4j.shell.impl.RmiLocation	remoteLocation(int port, String rmiName)

Methods inherited from class java.lang.Object

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

Field Detail

NO_INITIAL_SESSION

public static final Map<String,Serializable> NO_INITIAL_SESSION

Constructor Detail

ShellLobby

public ShellLobby()

Method Detail

newServer

public static ShellServer newServer(Class<? extends ShellServer> cls)
                             throws ShellException

To get rid of the RemoteException, uses a constructor without arguments.

Parameters:

cls - the class of the server to instantiate.

Returns:

a new shell server.

Throws:

ShellException - if the object couldn't be instantiated.

newClient

public static ShellClient newClient(ShellServer server,
                                    CtrlCHandler signalHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt.

Parameters:

server - the server (in the same JVM) which the client will communicate with.

signalHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if the execution fails

newClient

public static ShellClient newClient(ShellServer server)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt.

Parameters:

server - the server (in the same JVM) which the client will communicate with.

Returns:

the new shell client.

Throws:

ShellException - if the execution fails

newClient

public static ShellClient newClient(ShellServer server,
                                    Map<String,Serializable> initialSession,
                                    CtrlCHandler signalHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt.

Parameters:

server - the server (in the same JVM) which the client will communicate with.

initialSession - the initial session variables the shell will have, in addition to those provided by the server initially.

signalHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if the execution fails

newClient

public static ShellClient newClient(ShellServer server,
                                    Map<String,Serializable> initialSession,
                                    Output output,
                                    CtrlCHandler signalHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt.

Parameters:

server - the server (in the same JVM) which the client will communicate with.

initialSession - the initial session variables the shell will have, in addition to those provided by the server initially.

output - the output to write to.

signalHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if the execution fails

newClient

public static ShellClient newClient(int port,
                                    String name,
                                    CtrlCHandler ctrlcHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server on "localhost".

Parameters:

port - the RMI port.

name - the RMI name.

ctrlcHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient(int port)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server on "localhost" and default RMI name.

Parameters:

port - the RMI port.

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient(String host,
                                    int port,
                                    String name,
                                    CtrlCHandler ctrlcHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server to connect to.

Parameters:

host - the host (IP or domain name).

port - the RMI port.

name - the RMI name.

ctrlcHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient(String host,
                                    int port)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server to connect to. Uses default RMI name.

Parameters:

host - the host (IP or domain name).

port - the RMI port.

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient(org.neo4j.shell.impl.RmiLocation serverLocation,
                                    CtrlCHandler ctrlcHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server specified by serverLocation.

Parameters:

serverLocation - the RMI location of the server to connect to.

ctrlcHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient(org.neo4j.shell.impl.RmiLocation serverLocation,
                                    Map<String,Serializable> initialSession,
                                    CtrlCHandler ctrlcHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server specified by serverLocation.

Parameters:

serverLocation - the RMI location of the server to connect to.

initialSession - the initial session variables the shell will have, in addition to those provided by the server initially.

ctrlcHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient(String host,
                                    CtrlCHandler ctrlcHandler)
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server on host with default port and name.

Parameters:

host - host to connect to.

ctrlcHandler - the ctrl-c handler to use

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

newClient

public static ShellClient newClient()
                             throws ShellException

Creates a client and "starts" it, i.e. grabs the console prompt. It will try to find a remote server on localhost with default port and name.

Returns:

the new shell client.

Throws:

ShellException - if no server was found at the RMI location.

remoteLocation

public static org.neo4j.shell.impl.RmiLocation remoteLocation()

remoteLocation

public static org.neo4j.shell.impl.RmiLocation remoteLocation(int port)

remoteLocation

public static org.neo4j.shell.impl.RmiLocation remoteLocation(int port,
                                                              String rmiName)