library

Data Privacy Toolkit - Library

This project contains the Java Library at the core of the Data Privacy Toolkit (DPT). Refer to the documentation for information about the offered capabilities.

Requirements

The DPT library is a Java project, and it is currently being tested against the following releases:

• AdoptOpenJDK Hotspot 11
• AdoptOpenJDK Hotspot 17
• Microsoft Build of OpenJDK 11
• Microsoft Build of OpenJDK 17
• Amazon Corretto Build of OpenJDK 11
• Amazon Corretto Build of OpenJDK 17

and it currently builds using gradle version 8.0.2, offering gradle wrapper as a convenience tool.

Building the project

The library can be tested by running:

./gradlew build

This gradle task will compile the project, execute all the tests specified in the /src/test/java subfolder, and create the final jar file in the /build/libs subfolder.

Dependency declaration

DPT library is publicly available in the OSS repositories of MavenCentral.

repositories {
    repository {
        maven {
            url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
        }
        maven {
            url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
        }
    }
}

Therefore, the library can be used in any Java/Scala/Kotlin project by adding it as a traditional dependency. Examples are in the following.

Gradle:

dependencies {
    implementation "com.ibm.research.drl.dpt:data-privacy-toolkit:${dpt_version}"
}

Maven:

<dependency>
    <groupId>com.ibm.research.drl.dpt</groupId>
    <artifactId>data-privacy-toolkit</artifactId>
    <version>${dpt_version}</version>
    <type>jar</type>
</dependency>

where dpt_version is a variable specifying the latest version of the library, currently 6.0.0-SNAPSHOT.