org.neo4j.ogm.session

Class SessionFactory

java.lang.Object

org.neo4j.ogm.session.SessionFactory

public class SessionFactory
extends Object

Used to create Session instances for interacting with Neo4j.

Author:

Vince Bickers, Luanne Misquitta

Constructor Summary

Constructors

Constructor and Description
SessionFactory(String... packages) Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages.

Method Summary

Methods

Modifier and Type	Method and Description
MetaData	metaData() Retrieves the meta-data that was built up when this SessionFactory was constructed.
Session	openSession(String url) Opens a new Neo4j mapping Session against the specified Neo4j database.
Session	openSession(String url, String username, String password) Opens a new Neo4j mapping Session against the specified Neo4j database.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionFactory

public SessionFactory(String... packages)

Constructs a new SessionFactory by initialising the object-graph mapping meta-data from the given list of domain object packages.

The package names passed to this constructor should not contain wildcards or trailing full stops, for example, "org.springframework.data.neo4j.example.domain" would be fine. The default behaviour is for sub-packages to be scanned and you can also specify fully-qualified class names if you want to cherry pick particular classes.

Parameters:

packages - The packages to scan for domain objects

Method Detail

openSession

public Session openSession(String url)

Opens a new Neo4j mapping Session against the specified Neo4j database. The url may optionally contain the username and password to use while authenticating for example, http://username:password@neo-server:port Otherwise, if authentication is required, the username and password will be read from System properties.

Parameters:

url - The base URL of the Neo4j database with which to communicate.

Returns:

A new Session

openSession

public Session openSession(String url,
                  String username,
                  String password)

Opens a new Neo4j mapping Session against the specified Neo4j database.

Parameters:

url - The base URL of the Neo4j database with which to communicate

username - The username to authenticate with

password - The password to authenticate with

Returns:

A new Session

metaData

public MetaData metaData()

Retrieves the meta-data that was built up when this SessionFactory was constructed.

Returns:

The underlying MetaData