DatabunkerPro Java Client

A Java client library for interacting with the DatabunkerPro API. DatabunkerPro is a secure, privacy-focused data vault that helps organizations manage and protect sensitive user data.

Features

• Complete implementation of the DatabunkerPro API
• User management (create, get, update, delete, patch)
• App data management
• Legal basis and agreement management
• Connector management
• Group and role management
• Policy management
• Token management (including bulk operations)
• Audit management
• Tenant management
• Session management
• System configuration and metrics
• Bulk operations
• Shared record management
• Wrapping key generation for Shamir's Secret Sharing
• Typed options classes for better type safety
• Thread-safe implementation
• Comprehensive test suite
• Enhanced error handling

Requirements

• Java 11 or higher
• Maven 3.6 or higher

Installation

From GitHub Packages

Add the repository and dependency to your pom.xml:

<repositories>
    <repository>
        <id>github</id>
        <name>GitHub Packages</name>
        <url>https://maven.pkg.github.com/securitybunker/databunkerpro-java</url>
    </repository>
</repositories>

<dependency>
    <groupId>org.databunker</groupId>
    <artifactId>databunkerpro-java</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

From JitPack (Alternative)

Add the JitPack repository and dependency to your pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.securitybunker</groupId>
    <artifactId>databunkerpro-java</artifactId>
    <version>v1.0.0</version>
</dependency>

Note: Replace v1.0.0 with your desired version tag (e.g., v1.0.1, v2.0.0, etc.)

From Local Maven Repository

For development or internal use:

# Clone and install locally
git clone https://github.com/securitybunker/databunkerpro-java.git
cd databunkerpro-java
mvn clean install

Then add the dependency to your pom.xml:

<dependency>
    <groupId>org.databunker</groupId>
    <artifactId>databunkerpro-java</artifactId>
    <version>1.0.0-SNAPSHOT</version>
</dependency>

New Features in Latest Version

Enhanced API Methods

• Wrapping Key Generation: Generate wrapping keys from Shamir's Secret Sharing keys
• Typed Patch Operations: Use structured PatchOperation objects for user updates
• Bulk Token Operations: Create multiple tokens efficiently with typed options
• Shared Record Management: Create and retrieve shared records with partner organizations

Improved Error Handling

• Better HTTP status code handling
• Enhanced error messages and logging
• Graceful handling of API errors

Type Safety Improvements

• Structured patch operations with PatchOperation class
• Builder pattern for complex options
• Enhanced error handling

Usage

Basic Setup

import org.databunker.DatabunkerproApi;

// Initialize the API client
String apiUrl = "https://pro.databunker.org";
String apiToken = "your-api-token";
String tenantName = "your-tenant-name";

try (DatabunkerproApi api = new DatabunkerproApi(apiUrl, apiToken, tenantName)) {
    // Use the API client
}

User Management

// Create a user
Map<String, Object> profile = new HashMap<>();
profile.put("email", "[email protected]");
profile.put("name", "John Doe");
profile.put("phone", "+1234567890");

Map<String, Object> result = api.createUser(profile, null, null);
System.out.println("Created user with token: " + result.get("token"));

// Get a user
Map<String, Object> user = api.getUser("email", "[email protected]", null);
System.out.println("User profile: " + user.get("profile"));

// Update a user
Map<String, Object> updates = new HashMap<>();
updates.put("name", "John Smith");
api.updateUser("email", "[email protected]", updates, null);

// Delete a user
api.deleteUser("email", "[email protected]", null);

// Patch a user with typed operations
PatchOperation[] patchOps = {
    new PatchOperation("replace", "/profile/name", "Jane Doe"),
    new PatchOperation("add", "/profile/age", 25)
};
Map<String, Object> patchResult = api.patchUser("email", "[email protected]", patchOps, null);

### App Data Management

```java
// Create app data
Map<String, Object> data = new HashMap<>();
data.put("key", "value");
api.createAppData("email", "[email protected]", "appname", data, null);

// Get app data
Map<String, Object> appData = api.getAppData("email", "[email protected]", "appname", null);

System Configuration

// Get system statistics
Map<String, Object> stats = api.getSystemStats(null);
System.out.println("System statistics: " + stats.get("stats"));

// Generate wrapping key from Shamir's Secret Sharing keys
Map<String, Object> wrappingKey = api.generateWrappingKey("key1", "key2", "key3", null);
System.out.println("Generated wrapping key: " + wrappingKey.get("wrappingkey"));

// Get system metrics
Map<String, Object> metrics = api.getSystemMetrics(null);
System.out.println("System metrics: " + metrics);

Token Management

// Create a single token
TokenOptions tokenOptions = TokenOptions.builder()
    .slidingtime("1d")
    .finaltime("10d")
    .unique(true)
    .build();
Map<String, Object> token = api.createToken("creditcard", "1234567890", tokenOptions, null);

// Create multiple tokens in bulk
Map<String, Object>[] tokenRecords = new Map[2];
tokenRecords[0] = new HashMap<>();
tokenRecords[0].put("tokentype", "creditcard");
tokenRecords[0].put("record", "1234567890");
tokenRecords[1] = new HashMap<>();
tokenRecords[1].put("tokentype", "email");
tokenRecords[1].put("record", "[email protected]");

Map<String, Object> bulkTokens = api.createTokensBulk(tokenRecords, tokenOptions, null);

Shared Record Management

// Create a shared record
SharedRecordOptions sharedOptions = SharedRecordOptions.builder()
    .fields("name,email")
    .partner("partner-org")
    .appname("myapp")
    .finaltime("100d")
    .build();
Map<String, Object> sharedRecord = api.createSharedRecord("email", "[email protected]", sharedOptions, null);

// Get a shared record
Map<String, Object> retrievedRecord = api.getSharedRecord("record-uuid", null);

Testing

To run the tests use the following command:

mvn test

Deployment

The project supports deployment to both GitHub Packages and JitPack.

GitHub Packages Deployment

The project includes a GitHub Actions workflow that automatically:

• Builds the project on push to main branch
• Runs tests
• Deploys to GitHub Packages when triggered

To deploy:

1. Go to Actions tab in your GitHub repository
2. Select "Build java API" workflow
3. Click "Run workflow"
4. Set "Deploy to GitHub Packages" to true
5. Click "Run workflow"

JitPack Deployment (Alternative)

JitPack automatically builds and publishes your GitHub repository as a Maven dependency.

1. Create a Git tag for your release:

   git tag v1.0.0
   git push origin v1.0.0

2. JitPack automatically builds and publishes the package

3. Check build status at: https://jitpack.io/#securitybunker/databunkerpro-java

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support, please contact us at:

• Email: [email protected]
• Website: https://databunker.org
• GitHub Issues: https://github.com/securitybunker/databunkerpro-java/issues