{"id":19411469,"url":"https://github.com/volcengine/volc-sdk-java","last_synced_at":"2026-04-09T14:06:02.618Z","repository":{"id":43491464,"uuid":"307109790","full_name":"volcengine/volc-sdk-java","owner":"volcengine","description":null,"archived":false,"fork":false,"pushed_at":"2026-01-15T12:02:23.000Z","size":10990,"stargazers_count":84,"open_issues_count":1,"forks_count":40,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-17T22:17:40.792Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/volcengine.png","metadata":{"files":{"readme":"README.EN.MD","changelog":"Changelog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"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":"2020-10-25T13:52:35.000Z","updated_at":"2026-01-15T12:02:23.000Z","dependencies_parsed_at":"2026-01-15T14:10:33.959Z","dependency_job_id":null,"html_url":"https://github.com/volcengine/volc-sdk-java","commit_stats":null,"previous_names":[],"tags_count":241,"template":false,"template_full_name":null,"purl":"pkg:github/volcengine/volc-sdk-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolc-sdk-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolc-sdk-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolc-sdk-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolc-sdk-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/volcengine","download_url":"https://codeload.github.com/volcengine/volc-sdk-java/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volcengine%2Fvolc-sdk-java/sbom","scorecard":{"id":1152282,"data":{"date":"2025-08-04","repo":{"name":"github.com/volcengine/volc-sdk-java","commit":"9b7f0b3db25b7f759b7806549041182cc9295203"},"scorecard":{"version":"v5.2.1-28-gc1d103a9","commit":"c1d103a9bb9f635ec7260bf9aa0699466fa4be0e"},"score":4.2,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"15 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#cii-best-practices"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: android-example/src/main/java/com/volcengine/example/tls/android-demo/gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-h46c-h94j-95f3","Warn: Project is vulnerable to: GHSA-wf8f-6423-gfxg","Warn: Project is vulnerable to: GHSA-735f-pc8j-v9w8","Warn: Project is vulnerable to: GHSA-j288-q9x7-2f5v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c1d103a9bb9f635ec7260bf9aa0699466fa4be0e/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-28T19:01:46.992Z","repository_id":43491464,"created_at":"2025-08-28T19:01:46.993Z","updated_at":"2025-08-28T19:01:46.993Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28879173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T10:31:27.438Z","status":"ssl_error","status_checked_at":"2026-01-29T10:31:01.017Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2024-11-10T12:21:32.885Z","updated_at":"2026-01-29T14:15:16.461Z","avatar_url":"https://github.com/volcengine.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"English | [中文](README.md)\n\n\u003ch1 align=\"center\"\u003e\u003cimg src=\"https://iam.volccdn.com/obj/volcengine-public/pic/volcengine-icon.png\"\u003e\u003c/h1\u003e\n\u003ch1 align=\"center\"\u003eVolcengine SDK for Java\u003c/h1\u003e\n\nWelcome to Volcengine SDK for Java. This document explains how to obtain and use the SDK.\n\n## Prerequisites\n\n### Enable the service\n\nMake sure the service you want to access is enabled. Go to the [Volcengine Console](https://console.volcengine.com/), select the service from the left navigation (or search it from the top bar), and complete the activation process in the service console.\n\n### Obtain security credentials\n\nAccess Key is the credential used to access Volcengine services. It consists of Access Key ID (AK) and Secret Access Key (SK).\n\nLog in to the [Volcengine Console](https://console.volcengine.com/), then go to [IAM](https://console.volcengine.com/iam) -\u003e [Access Keys](https://console.volcengine.com/iam/keymanage/) to create and manage your Access Keys. For more information, see the [Access Key documentation](https://www.volcengine.com/docs/6291/65568).\n\n## Install\n\nWe recommend using Maven dependencies to integrate Volcengine SDK for Java.\n\n[![maven](https://img.shields.io/maven-central/v/com.volcengine/volc-sdk-java)](https://search.maven.org/artifact/com.volcengine/volc-sdk-java)\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.volcengine\u003c/groupId\u003e\n    \u003cartifactId\u003evolc-sdk-java\u003c/artifactId\u003e\n    \u003cversion\u003elatest\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nIf your Java version is **Java 9 or later**, add `javax.annotation-api` because it was removed from JDK 9+.\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ejavax.annotation\u003c/groupId\u003e\n  \u003cartifactId\u003ejavax.annotation-api\u003c/artifactId\u003e\n  \u003cversion\u003e1.3.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### SNAPSHOT release notes\n\n[Version: 2.0.1-SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/com/volcengine/volc-sdk-java)\n\n*Note: SNAPSHOT versions may have potential issues. The source branch is `2.0.0-SNAPSHOT`. If you need support, please submit a [ticket](https://console.volcengine.com/workorder/create) and select the corresponding product.*\n\n#### Changes\n\n1. Use OkHttp as the underlying HTTP component (Android compatible)\n2. Fix potential thread leaks when using many credentials\n3. Abstract some network-related models to avoid conflicts\n4. Business packages are mostly unaffected, so migration should be smooth\n\nHow to use the SNAPSHOT version:\n\n1. Add the SNAPSHOT Maven repository (SNAPSHOT policy settings are up to you)\n\n```xml\n\u003crepository\u003e\n   \u003cid\u003esnapshots-repo\u003c/id\u003e\n   \u003curl\u003ehttps://oss.sonatype.org/content/repositories/snapshots/\u003c/url\u003e\n\u003c/repository\u003e\n```\n\n2. Add dependency\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.volcengine\u003c/groupId\u003e\n    \u003cartifactId\u003evolc-sdk-java\u003c/artifactId\u003e\n    \u003cversion\u003e2.0.1-SNAPSHOT\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Configuration\n\n### Credential configuration\n\nVolcengine SDK for Java supports the following credential loading methods.\n\n*Note: Replace `Your AK` and `Your SK` in the code with your actual AK and SK.*\n\n**Method 1**: Specify AK/SK explicitly on the client **(recommended)**\n\n```java\niamService.setAccessKey(\"Your AK\");\niamService.setSecretKey(\"Your SK\");\n```\n\n**Method 2**: Load AK/SK from environment variables\n\n```bash\nVOLC_ACCESSKEY=\"Your AK\"\nVOLC_SECRETKEY=\"Your SK\"\n```\n\n**Method 3**: Load AK/SK from a file under HOME\n\nAdd the following content to `~/.volc/config`:\n\n```json\n{\n  \"ak\": \"Your AK\",\n  \"sk\": \"Your SK\"\n}\n```\n\n### Release resources\n\nAfter calling APIs, explicitly call `destroy()` to release daemon threads.\n\n```java\niamService.destroy()\n```\n\n## Other resources\n\nExamples are available under [example](./example)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolcengine%2Fvolc-sdk-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolcengine%2Fvolc-sdk-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolcengine%2Fvolc-sdk-java/lists"}