README.md

Requirements for and how to build Tsubakuro

Requirements

JDK

• OpenJDK 11 (see https://docs.microsoft.com/ja-jp/java/openjdk/download) The environment variables JAVA_HOME and PATH should be as follows; set JAVA_HOME to the directory where the JDK is installed, and add the directory where the java command exists to PATH.

Dependency packages for Native Library

Tsubakuro needs to install several packages for Native Libarary builds. See Dockerfile section.

Dockerfile

FROM ubuntu:22.04

RUN apt update -y && apt install -y git build-essential cmake libboost-system-dev openjdk-11-jdk

How to build

full build

Build java libraries(jar) and native shared libraries(so).

cd ${ProjectTopDirectory}
./gradlew build

where ${ProjectTopDirectory} is a directory created by clone of the tsubakuro repository in git (https://github.com/project-tsurugi/tsubakuro).

build only java libraries

Build only java libraries and skip testing and building native libraries.

./gradlew assemble -PskipBuildNative

install

Build and deploy the java and native libraries into Maven Local Repository.

./gradlew PublishToMavenLocal

install only java libraries

Build and deploy only the java libraries into Maven Local Repository.

./gradlew PublishMavenJavaPublicationToMavenLocal -PskipBuildNative

generate all(aggregated) Javadoc

Generate Javadoc for whole Tsubakuro classes in directory ${ProjectTopDirectory}/build/docs/javadoc-all.

cd ${ProjectTopDirectory}
./gradlew allJavadoc

Generated in directory ${ProjectTopDirectory}/build/docs/javadoc-all

generate Javadoc for client API

Generate Javadoc for Tsubakuro client API in directory ${ProjectTopDirectory}/build/docs/javadoc-client-api.

cd ${ProjectTopDirectory}
./gradlew clientApiJavadoc

How to use

Setup dependencies

To use on Gradle, add Tsubakuro libraries and SLF4J implementation library to dependencies.

dependencies {
    implementation 'com.tsurugidb.tsubakuro:tsubakuro-session:1.0.0'
    implementation 'com.tsurugidb.tsubakuro:tsubakuro-connector:1.0.0'

    implementation 'org.slf4j:slf4j-simple:1.7.32'
}