Module org.neo4j.jdbc

Package org.neo4j.jdbc

Class Neo4jDataSource

java.lang.Object

org.neo4j.jdbc.Neo4jDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource, Neo4jDataSourceExtensions

public final class Neo4jDataSource
extends Object
implements Neo4jDataSourceExtensions

A Neo4j specific extension of DataSource. It may be referred to for use with unwrap(Class) to access specific Neo4j functionality.

Since:

6.0.0

Author:

Michael J. Simons

Constructor Summary

Constructors

Constructor	Description
Neo4jDataSource()	Creates a new DataSource which is not yet usable without further configuration.

Method Summary

Modifier and Type	Method	Description
Connection	getConnection()
Connection	getConnection(String username, String password)
String	getDatabaseName()	Returns the name of the database to use.
int	getLoginTimeout()
PrintWriter	getLogWriter()
Logger	getParentLogger()
String	getPassword()	Returns the password for the user that connects to the database.
int	getPortNumber()	Returns the port number.
String	getServerName()	Returns the server name or IP address to connect against.
String	getTransportProtocol()	Returns the transport protocol.
String	getUser()	Returns the user that should be connected to the database.
boolean	isWrapperFor(Class<?> iface)
void	setConnectionProperty(String name, String value)	Sets a connection property on the data source.
void	setDatabaseName(String databaseName)	Configures the database to use.
void	setLoginTimeout(int seconds)
void	setLogWriter(PrintWriter out)
void	setPassword(String password)	Configures the password to use.
void	setPortNumber(int portNumber)	Configures the port number to use.
void	setServerName(String serverName)	Configures the server name or IP address to connect against.
void	setTransportProtocol(String transportProtocol)	Configures the transport protocol, might be null or empty, s or ssc.
void	setUser(String user)	Configures the user that should be connected to the database.
<T> T	unwrap(Class<T> iface)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

createShardingKeyBuilder

Methods inherited from interface javax.sql.DataSource

createConnectionBuilder

Constructor Details

Neo4jDataSource

public Neo4jDataSource()

Creates a new DataSource which is not yet usable without further configuration. This constructor is mainly used for tooling that loads data sources via reflection.

Method Details

getDatabaseName

public String getDatabaseName()

Description copied from interface: Neo4jDataSourceExtensions

Returns the name of the database to use.

Specified by:

getDatabaseName in interface Neo4jDataSourceExtensions

Returns:

the name of the database to use

setDatabaseName

public void setDatabaseName(String databaseName)

Description copied from interface: Neo4jDataSourceExtensions

Configures the database to use.

Specified by:

setDatabaseName in interface Neo4jDataSourceExtensions

Parameters:

databaseName - a database name

getPassword

public String getPassword()

Description copied from interface: Neo4jDataSourceExtensions

Returns the password for the user that connects to the database.

Specified by:

getPassword in interface Neo4jDataSourceExtensions

Returns:

the password for the user that connects to the database

setPassword

public void setPassword(String password)

Description copied from interface: Neo4jDataSourceExtensions

Configures the password to use.

Specified by:

setPassword in interface Neo4jDataSourceExtensions

Parameters:

password - a password

getPortNumber

public int getPortNumber()

Description copied from interface: Neo4jDataSourceExtensions

Returns the port number.

Specified by:

getPortNumber in interface Neo4jDataSourceExtensions

Returns:

the port number

setPortNumber

public void setPortNumber(int portNumber)

Description copied from interface: Neo4jDataSourceExtensions

Configures the port number to use.

Specified by:

setPortNumber in interface Neo4jDataSourceExtensions

Parameters:

portNumber - the new port number

getServerName

public String getServerName()

Description copied from interface: Neo4jDataSourceExtensions

Returns the server name or IP address to connect against.

Specified by:

getServerName in interface Neo4jDataSourceExtensions

Returns:

the server name

setServerName

public void setServerName(String serverName)

Description copied from interface: Neo4jDataSourceExtensions

Configures the server name or IP address to connect against.

Specified by:

setServerName in interface Neo4jDataSourceExtensions

Parameters:

serverName - the new server name

getUser

public String getUser()

Description copied from interface: Neo4jDataSourceExtensions

Returns the user that should be connected to the database.

Specified by:

getUser in interface Neo4jDataSourceExtensions

Returns:

the user

setUser

public void setUser(String user)

Description copied from interface: Neo4jDataSourceExtensions

Configures the user that should be connected to the database.

Specified by:

setUser in interface Neo4jDataSourceExtensions

Parameters:

user - the new user

getTransportProtocol

public String getTransportProtocol()

Description copied from interface: Neo4jDataSourceExtensions

Returns the transport protocol.

Specified by:

getTransportProtocol in interface Neo4jDataSourceExtensions

Returns:

the transport protocol

setTransportProtocol

public void setTransportProtocol(String transportProtocol)

Description copied from interface: Neo4jDataSourceExtensions

Configures the transport protocol, might be null or empty, s or ssc.

Specified by:

setTransportProtocol in interface Neo4jDataSourceExtensions

Parameters:

transportProtocol - the new protocol

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String username,
 String password)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getLogWriter

public PrintWriter getLogWriter()

Specified by:

getLogWriter in interface CommonDataSource

Specified by:

getLogWriter in interface DataSource

setLogWriter

public void setLogWriter(PrintWriter out)

Specified by:

setLogWriter in interface CommonDataSource

Specified by:

setLogWriter in interface DataSource

setLoginTimeout

public void setLoginTimeout(int seconds)

Specified by:

setLoginTimeout in interface CommonDataSource

Specified by:

setLoginTimeout in interface DataSource

getLoginTimeout

public int getLoginTimeout()

Specified by:

getLoginTimeout in interface CommonDataSource

Specified by:

getLoginTimeout in interface DataSource

getParentLogger

public Logger getParentLogger()

Specified by:

getParentLogger in interface CommonDataSource

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

setConnectionProperty

public void setConnectionProperty(String name,
 String value)

Description copied from interface: Neo4jDataSourceExtensions

Sets a connection property on the data source.

Specified by:

setConnectionProperty in interface Neo4jDataSourceExtensions

Parameters:

name - the name of the connection property to be set

value - the value of the connection property to be set