Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
</p>

# Box Java SDK
# Box Java SDK v5

[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
![Platform](https://img.shields.io/badge/java-%3E%3D8-blue)
Expand All @@ -13,6 +13,7 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Introduction](#introduction)
- [Supported versions](#supported-versions)
- [Version v5](#version-v5)
- [Version v10](#version-v10)
Expand All @@ -28,7 +29,6 @@
- [Migration guides](#migration-guides)
- [Versioning](#versioning)
- [Version schedule](#version-schedule)
- [Version schedule](#version-schedule-1)
- [Contributing](#contributing)
- [3rd Party Libraries & Licenses](#3rd-party-libraries--licenses)
- [Android](#android)
Expand All @@ -38,9 +38,24 @@

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Introduction

We are excited to introduce the v5 major release of the Box Java SDK,
designed to elevate the developer experience and streamline your integration with the Box Content Cloud.

With this SDK version, alongside the existing `com.box.sdk` package, we’re introducing a new `com.box.sdkgen` package, which gives you access to:

1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.
4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.
5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.

Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.

# Supported versions

To enhance developer experience, provide full Box API coverage, and rapid updates we have introduced the new generated codebase through the `com.box.sdkgen` package.
To enhance developer experience, we have introduced the new generated codebase through the `com.box.sdkgen` package.
The `com.box.sdkgen` package is available in two major supported versions: v5 and v10.

## Version v5
Expand Down Expand Up @@ -218,8 +233,6 @@ We highly recommend upgrading to the latest SDK major release at the earliest co

## Version schedule

### Version schedule

| Version | Supported Environments | State | First Release | EOL/Terminated |
|---------|------------------------|-----------|---------------|------------------------|
| 10 | Java 8 and up | Supported | 17 Sep 2025 | TBD |
Expand Down Expand Up @@ -330,8 +343,8 @@ Furthermore,using Bouncy Castle v.1.57 may lead to [Bouncycastle BadPaddingExcep
Gradle example
```groovy
implementation('com.box:box-java-sdk:x.y.z') {
exclude group: 'org.bouncycastle', module: 'bcprov-jdk15on'
exclude group: 'org.bouncycastle', module: 'bcpkix-jdk15on'
exclude group: 'org.bouncycastle', module: 'bcprov-jdk18on'
exclude group: 'org.bouncycastle', module: 'bcpkix-jdk18on'
}
runtimeOnly('org.bouncycastle:bcprov-jdk15on:1.57')
runtimeOnly('org.bouncycastle:bcpkix-jdk15on:1.57')
Expand All @@ -348,11 +361,11 @@ Maven example:
<exclusions>
<exclusion>
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk15on</artifactId>
<artifactId>bcprov-jdk18on</artifactId>
</exclusion>
<exclusion>
<groupId>org.bouncycastle</groupId>
<artifactId>bcpkix-jdk15on</artifactId>
<artifactId>bcpkix-jdk18on</artifactId>
</exclusion>
</exclusions>
</dependency>
Expand All @@ -379,7 +392,7 @@ back to you. If you have general questions about the Box API, you can post to th

## Copyright and License

Copyright 2019 Box, Inc. All rights reserved.
Copyright 2025 Box, Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down