{"id":35752747,"url":"https://github.com/atlanhq/atlan-java","last_synced_at":"2026-03-13T00:05:33.561Z","repository":{"id":59194269,"uuid":"520357429","full_name":"atlanhq/atlan-java","owner":"atlanhq","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-13T17:35:26.000Z","size":946589,"stargazers_count":9,"open_issues_count":0,"forks_count":5,"subscribers_count":13,"default_branch":"main","last_synced_at":"2026-01-13T18:39:00.418Z","etag":null,"topics":["api-client","java","sdk"],"latest_commit_sha":null,"homepage":"https://developer.atlan.com/sdks/java/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atlanhq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-08-02T04:58:29.000Z","updated_at":"2026-01-13T16:28:09.000Z","dependencies_parsed_at":"2023-10-16T10:33:49.587Z","dependency_job_id":"61ab472d-e5f0-404a-95a9-5222e0b58920","html_url":"https://github.com/atlanhq/atlan-java","commit_stats":null,"previous_names":[],"tags_count":133,"template":false,"template_full_name":null,"purl":"pkg:github/atlanhq/atlan-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlanhq%2Fatlan-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlanhq%2Fatlan-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlanhq%2Fatlan-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlanhq%2Fatlan-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atlanhq","download_url":"https://codeload.github.com/atlanhq/atlan-java/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlanhq%2Fatlan-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28603402,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T12:01:53.233Z","status":"ssl_error","status_checked_at":"2026-01-20T12:01:46.545Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","java","sdk"],"created_at":"2026-01-06T20:26:10.669Z","updated_at":"2026-03-13T00:05:33.529Z","avatar_url":"https://github.com/atlanhq.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- SPDX-License-Identifier: CC-BY-4.0 --\u003e\n\u003c!-- Copyright 2022 Atlan Pte. Ltd. --\u003e\n\n[![Build](https://github.com/atlanhq/atlan-java/workflows/Merge/badge.svg)](https://github.com/atlanhq/atlan-java/actions/workflows/merge.yml?query=workflow%3AMerge)\n[![JavaDocs](https://img.shields.io/badge/javadocs-passing-success)](https://atlanhq.github.io/atlan-java/)\n[![Release](https://img.shields.io/maven-central/v/com.atlan/atlan-java?label=release)](https://central.sonatype.com/artifact/com.atlan/atlan-java)\n\u003c!--[![Development](https://img.shields.io/nexus/s/com.atlan/atlan-java?label=development\u0026server=https%3A%2F%2Fs01.oss.sonatype.org)](https://s01.oss.sonatype.org/content/repositories/snapshots/com/atlan/atlan-java/) --\u003e\n\u003c!--[![CodeQL](https://github.com/atlanhq/atlan-java/workflows/CodeQL/badge.svg)](https://github.com/atlanhq/atlan-java/actions/workflows/codeql-analysis.yml) --\u003e\n\n# Atlan Java\n\nThis repository houses the Java-based utilities for interacting with [Atlan](https://atlan.com):\n\n- `sdk` the Atlan Java SDK (client library), that ultimately calls through to Atlan's REST APIs\n- `package-toolkit` for configuring, running and testing custom packages\n- `integration-tests` for automated regression-testing\n- `samples` illustrating how the other components can be used for real automations and integrations\n- `mocks` bundle wire mocks that are reused in unit tests across different projects\n\nThese additional directories serve other purposes:\n\n- `containers` defines the container image that bundles the SDK and custom package toolkits, and container images for each custom package sample\n- `gradle` contains Gradle build bootstrapping and dependency version catalog\n- `buildSrc` contains code for the Gradle multi-project build process (in particular, convention plugins)\n\n## [Documentation](https://developer.atlan.com/getting-started/java-sdk/)\n\nFor guides on actually using the various utilities housed in this repository, see: [https://developer.atlan.com/getting-started/java-sdk/](https://developer.atlan.com/getting-started/java-sdk/)\n\n## Installing for Development\n\n### Initial Setup\nTo get started developing the SDK:\n\n1. Clone the repository:\n   ```shell\n   git clone ..\n   ```\n\n2. Ensure you have the Java 17 SDK installed. For example, on macOS:\n   ```shell\n   brew install openjdk@..\n   ```\n\n### Building the SDK\nTo build the SDK, from within the root of the cloned repository:\n```shell\n./gradlew assemble shadowJar\n```\nNote that we use the Gradle build tool. This accelerates subsequent rebuilds through things like caching, and thus only needing to rebuild paths within the project that have changed from one build to another.\n\n\n\n### Code Formatting\nBefore committing code, ensure it adheres to the repository's formatting guidelines. You can apply the required formatting using:\n\n```shell\n./gradlew spotlessApply\n```\n\n## Testing the SDK\n### Environment Setup\nFor running integration tests, you'll need to configure your environment:\n\n1. Copy the example environment file:\n   ```shell\n   cp .env.example .env\n   ```\n2. Update the `.env` file with your Atlan API key and base URL.\n3. Export the environment variables:\n    - For macOS/Linux:\n      ```shell\n      export $(cat .env | xargs)\n      ```\n    - For Windows (PowerShell):\n      ```shell\n      Get-Content .env | ForEach-Object {\n          if ($_ -match '^(.*?)=(.*)$') {\n              $env:($matches[1]) = $matches[2]\n          }\n      }\n      ```\n\n### Running Unit Tests\nYou can run the SDK's unit tests **without needing access to an Atlan environment**:\n\n```shell\n./gradlew test\n```\n\n### Running Integration Tests\nOnce the environment is set up, you can run integration tests:\n\n- Base SDK integration tests:\n  ```shell\n  ./gradlew test -PintegrationTests\n  ```\n- Package-specific integration tests:\n  ```shell\n  ./gradlew test -PpackageTests\n  ```\n\n\n## Attribution\n\nPortions of the SDK are based on original work from https://github.com/stripe/stripe-java. Those classes that derive from this original work have an extra heading comment as follows:\n\n```java\n/* Based on original code from https://github.com/stripe/stripe-java (under MIT license) */\n```\n\nThe original MIT license under which these were used is included here:\n\n```text\nThe MIT License\n\nCopyright (c) 2011- Stripe, Inc. (https://stripe.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n\n----\nLicense: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),\nCopyright 2022 Atlan Pte. Ltd.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlanhq%2Fatlan-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatlanhq%2Fatlan-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlanhq%2Fatlan-java/lists"}