Connection

After installing the Ultipa Java SDK and setting up a running Ultipa instance, you should be able to connect your application to the Ultipa graph database.

Connection to Ultipa can be established by creating a driver with configurations specified using either or both of the following methods:

• Code Configuration Connection: through the UltipaConfiguration class
• File Configuration Connection: through the ultipa.properties file

The values of configuration items are preferentially determined by UltipaConfiguration, followed by ultipa.properties. If an item is not found in either configuration, the default value is used.

Code Configuration Connection

Main.java
package com.ultipa.www.sdk.api;

import com.ultipa.sdk.connect.Connection;
import com.ultipa.sdk.connect.conf.UltipaConfiguration;
import com.ultipa.sdk.connect.driver.UltipaClientDriver;

public class Main {
    public static void main(String[] args) {
        UltipaConfiguration myConfig = UltipaConfiguration.config()
            // URI example: .hosts("mqj4zouys.us-east-1.cloud.ultipa.com:60010")
            .hosts("192.168.1.85:60061,192.168.1.86:60061,192.168.1.87:60061")
            .username("<username>")
            .password("<password>")
            .defaultGraph("default");

        UltipaClientDriver driver = null;
        try {
            driver = new UltipaClientDriver(myConfig);
            Connection client = driver.getConnection("amz");

            String reply = client.sayHello("Hi");
            System.out.println(reply);
        } finally {
            if (driver != null) {
                driver.close();
            }
        }
    }
}

Output
Hi Welcome To Ultipa!

A driver is created with the configurations specified using UltipaConfiguration. Please refer to Configuration Items for all items available for configuring connection details with UltipaConfiguration.

The getConnection() method obtains a connection to Ultipa, allowing you to optionally specify a graphset as the current graphset (in this case, amz). If no graph is specified, the graphset identified by the configuration item defaultGraph will be used.

File Configuration Connection

Main.java
package com.ultipa.www.sdk.api;

import com.ultipa.sdk.connect.Connection;
import com.ultipa.sdk.connect.conf.UltipaConfiguration;
import com.ultipa.sdk.connect.driver.UltipaClientDriver;

public class Main {
    public static void main(String[] args) {
        UltipaClientDriver driver = null;
        try {
            driver = new UltipaClientDriver();
            Connection client = driver.getConnection();

            String reply = client.sayHello("Hi");
            System.out.println(reply);
        } finally {
            if (driver != null) {
                driver.close();
            }
        }
    }
}

A driver is created with the configurations specified using the ultipa.properties file. The ultipa.properties file should be placed under the classpath of Java project, which is by default ./src/main/resources.

Example of the ultipa.properties file:

ultipa.properties
ultipa.hosts=192.168.1.85:60061,192.168.1.86:60061,192.168.1.87:60061
#ultipa.hosts=mqj4zouys.us-east-1.cloud.ultipa.com:60010
ultipa.username=<username>
ultipa.password=<password>
ultipa.passwordEncrypt=NOTHING
ultipa.defaultGraph=amz
# ultipa.crt=F:\\ultipa.crt
# ultipa.overrideAuthority=ultipa
# ultipa.crt=https
# ultipa.crt=
ultipa.keepAlive=180
ultipa.keepAliveWithoutCalls=true
ultipa.pool.maxIdle=50
ultipa.pool.minIdle=20
ultipa.pool.maxTotal=200
ultipa.pool.timeBetweenEvictionRunsMillis=3600000
ultipa.pool.testOnBorrow=true

Please refer to Configuration Items for all items available for configuring connection details with the ultipa.properties file.

Configuration Items

Below are all the configuration items available for UltipaConfiguration and ultipa.properties:

Connection Pooling

PoolConfig contains the configuration settings for using the Apache Commons Pool library. These settings are necessary when connecting to a database to efficiently handle and reuse connections.

Main.java
package com.ultipa.www.sdk.api;

import com.ultipa.sdk.connect.Connection;
import com.ultipa.sdk.connect.conf.UltipaConfiguration;
import com.ultipa.sdk.connect.driver.UltipaClientDriver;

public class Main {
    public static void main(String[] args) {
        UltipaConfiguration myConfig = UltipaConfiguration.config()
            // URI example: .hosts("mqj4zouys.us-east-1.cloud.ultipa.com:60010")
            .hosts("192.168.1.85:60061,192.168.1.86:60061,192.168.1.87:60061")
            .username("<username>")
            .password("<password>");

        PoolConfig poolConfig = myConfig.getPoolConfig();
        poolConfig.setMaxIdle(50);
        poolConfig.setMinIdle(2);
        poolConfig.setMaxTotal(200);

        UltipaClientDriver driver = null;
        try {
            driver = new UltipaClientDriver(myConfig);
            Connection client = driver.getConnection();

            String reply = client.sayHello("Hi");
            System.out.println(reply);
        } finally {
            if (driver != null) {
                driver.close();
            }
        }
    }
}

PoolConfig has the following fields:

Data Source

By setting the configurations and the target graph in a DataSource, you can easily pass all necessary connection information to the UltipaClientDriver when creating a connection.

NOTE

When UltipaClientDriver is instantiated using DataSource, the ultipa.properties file is ignored.

Main.java
package com.ultipa.www.sdk.api;

import com.ultipa.sdk.connect.Connection;
import com.ultipa.sdk.connect.conf.UltipaConfiguration;
import com.ultipa.sdk.connect.driver.UltipaClientDriver;

public class Main {
    public static void main(String[] args) {
        UltipaConfiguration myConfig = UltipaConfiguration.config()
            // URI example: .hosts("mqj4zouys.us-east-1.cloud.ultipa.com:60010")
            .hosts("192.168.1.85:60061,192.168.1.86:60061,192.168.1.87:60061")
            .username("<username>")
            .password("<password>");

        PoolConfig poolConfig = myConfig.getPoolConfig();
        poolConfig.setMaxIdle(50);
        poolConfig.setMinIdle(2);
        poolConfig.setMaxTotal(200);

        DataSource dataSource = new DataSource();
        dataSource.setUltipaConfiguration(myConfig);
        dataSource.setDefaultGraph("amz");

        UltipaClientDriver driver = null;
        try {
            driver = new UltipaClientDriver(dataSource);
            Connection client = driver.getConnection();

            String reply = client.sayHello("Hi");
            System.out.println(reply);
        } finally {
            if (driver != null) {
                driver.close();
            }
        }
    }
}

Close Connection

The driver object can be reused across multiple threads, and the connection can be properly closed by calling the driver.close() method.