|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.neo4j.remote.RemoteGraphDatabase
public final class RemoteGraphDatabase
A remote connection to a running Graph Database
instance, providing access to the Neo4j Graph Database API.
Constructor Summary | |
---|---|
RemoteGraphDatabase(ConfigurationModule config,
ConnectionTarget site)
Creates a new remote graph database connection. |
|
RemoteGraphDatabase(ConfigurationModule config,
ConnectionTarget site,
String username,
String password)
Creates a new remote graph database connection. |
|
RemoteGraphDatabase(ConfigurationModule config,
String resourceUri)
Create a remote graph database connection. |
|
RemoteGraphDatabase(ConfigurationModule config,
String resourceUri,
String username,
String password)
Create a remote graph database connection. |
|
RemoteGraphDatabase(ConnectionTarget site)
Creates a new remote graph database connection. |
|
RemoteGraphDatabase(ConnectionTarget site,
String username,
String password)
Creates a new remote graph database connection. |
|
RemoteGraphDatabase(String resourceUri)
Create a remote graph database connection. |
|
RemoteGraphDatabase(String resourceUri,
String username,
String password)
Create a remote graph database connection. |
Method Summary | |
---|---|
Transaction |
beginTx()
Starts a new transaction and associates it with the current thread. |
Node |
createNode()
Creates a new node. |
boolean |
enableRemoteShell()
Enables remote shell access (with default configuration) to this Neo4j instance, if the Neo4j shell component is available on the classpath. |
boolean |
enableRemoteShell(Map<String,Serializable> initialProperties)
Enables remote shell access to this Neo4j instance, if the Neo4j Shell component is available on the classpath. |
Iterable<Node> |
getAllNodes()
Returns all nodes in the node space. |
Node |
getNodeById(long id)
Looks up a node by id. |
Node |
getReferenceNode()
Returns the reference node, which is a "starting point" in the node space. |
Relationship |
getRelationshipById(long id)
Looks up a relationship by id. |
Iterable<RelationshipType> |
getRelationshipTypes()
Returns all relationship types currently in the underlying store. |
static void |
registerProtocol(Transport factory)
Register a ConnectionTarget implementation with a specified protocol. |
void |
shutdown()
Shuts down Neo4j. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RemoteGraphDatabase(ConnectionTarget site)
site
- The connection layer to be used.public RemoteGraphDatabase(ConfigurationModule config, ConnectionTarget site)
config
- the ConfigurationModule
containing the configurations
of the subsystems of the graph database.site
- The connection layer to be used.public RemoteGraphDatabase(ConnectionTarget site, String username, String password)
site
- The connection layer to be used.username
- the name of the user to log in as on the remote site. (
null
means anonymous)password
- the password for the user to log in as on the remote site.public RemoteGraphDatabase(ConfigurationModule config, ConnectionTarget site, String username, String password)
config
- the ConfigurationModule
containing the configurations
of the subsystems of the graph database.site
- The connection layer to be used.username
- the name of the user to log in as on the remote site. (
null
means anonymous)password
- the password for the user to log in as on the remote site.public RemoteGraphDatabase(String resourceUri) throws URISyntaxException
resourceUri
- the URI where the connection resource is located.
URISyntaxException
- if the resource URI is malformed.public RemoteGraphDatabase(ConfigurationModule config, String resourceUri) throws URISyntaxException
config
- the ConfigurationModule
containing the configurations
of the subsystems of the graph database.resourceUri
- the URI where the connection resource is located.
URISyntaxException
- if the resource URI is malformed.public RemoteGraphDatabase(String resourceUri, String username, String password) throws URISyntaxException
resourceUri
- the URI where the connection resource is located.username
- the name of the user to log in as on the remote site. (
null
means anonymous)password
- the password for the user to log in as on the remote site.
URISyntaxException
- if the resource URI is malformed.public RemoteGraphDatabase(ConfigurationModule config, String resourceUri, String username, String password) throws URISyntaxException
config
- the ConfigurationModule
containing the configurations
of the subsystems of the graph database.resourceUri
- the URI where the connection resource is located.username
- the name of the user to log in as on the remote site. (
null
means anonymous)password
- the password for the user to log in as on the remote site.
URISyntaxException
- if the resource URI is malformed.Method Detail |
---|
public static void registerProtocol(Transport factory)
ConnectionTarget
implementation with a specified protocol.
factory
- a factory to create the site once it's required.public Transaction beginTx()
GraphDatabaseService
beginTx
in interface GraphDatabaseService
public Node createNode()
GraphDatabaseService
createNode
in interface GraphDatabaseService
public Node getNodeById(long id)
GraphDatabaseService
getNodeById
in interface GraphDatabaseService
id
- the id of the node
id
if foundpublic Relationship getRelationshipById(long id)
GraphDatabaseService
getRelationshipById
in interface GraphDatabaseService
id
- the id of the relationship
id
if foundpublic Node getReferenceNode()
GraphDatabaseService
getReferenceNode
in interface GraphDatabaseService
public Iterable<RelationshipType> getRelationshipTypes()
GraphDatabaseService
node.createRelationshipTo(...)
. Note that this method is guaranteed to
return all known relationship types, but it does not guarantee that it
won't return more than that (e.g. it can return "historic"
relationship types that no longer have any relationships in the node
space).
getRelationshipTypes
in interface GraphDatabaseService
public Iterable<Node> getAllNodes()
GraphDatabaseService
getAllNodes
in interface GraphDatabaseService
public void shutdown()
GraphDatabaseService
shutdown
in interface GraphDatabaseService
public boolean enableRemoteShell()
GraphDatabaseService
enableRemoteShell( null )
.
enableRemoteShell
in interface GraphDatabaseService
true
if the shell has been enabled,
false
otherwise (false
usually
indicates that the shell
jar dependency is not on
the classpath)public boolean enableRemoteShell(Map<String,Serializable> initialProperties)
GraphDatabaseService
org.neo4j.shell.ShellClient
from the Neo4j Shell project.
Typically, the neo4j-shell
binary package is used (see neo4j.org/download).
The shell is parameterized by a map of properties passed in to this method. Currently, two properties are used:
port
, an Integer
describing the port of the RMI
registry where the Neo4j shell will be bound, defaults to
1337
name
, the String
under which the Neo4j shell
will be bound in the RMI registry, defaults to shell
enableRemoteShell
in interface GraphDatabaseService
initialProperties
- a set of properties that will be used to
configure the remote shell, or null
if the
default properties should be used
true
if the shell has been enabled,
false
otherwise (false
usually
indicates that the shell
jar dependency is not on
the classpath)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |