Skip to content

Latest commit

 

History

History
819 lines (498 loc) · 52.2 KB

CHANGELOG.md

File metadata and controls

819 lines (498 loc) · 52.2 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

4.13.1 (2024-11-29)

Bug Fixes:

  • Correctly calculate Content-Length when reading from a stream (#1277) (b1d5371)

4.13.0 (2024-11-21)

New Features and Enhancements:

  • Enforce exact byte reading from Content-Length header for BoxFile representation (#1274) (0b45cdb)
  • Expose getVersionByID method on BoxFile (#1268) (6ea70f7)
  • make tryRestoreUsingAccessTokenCache in Box API connection public (#1272) (50f5a61)

Bug Fixes:

4.12.0 (2024-10-17)

New Features and Enhancements:

4.11.1 (2024-07-16)

Bug Fixes:

  • Fix order of file upload multipart request (#1261) (7200ac7)

4.11.0 (2024-07-15)

New Features and Enhancements:

  • Allow overriding creation of OkHttp Call (#1257) (bd6fde6)

Bug Fixes:

  • Add missing fields when update classification template (#1255) (f17f817)
  • Fix deserializing permissions for BoxFile and BoxFolder (#1256) (f088448)

4.10.0 (2024-06-06)

New Features and Enhancements:

  • Overload the getRepresentationContent method with a maxRetries parameter (#1251) (d26bd4f)
  • Support login_required, password, suppress_nofitications, verification_phone_number and additional_info fields in sign request (#1250) (3ee55b3)

4.9.1 (2024-05-20)

Bug Fixes:

  • Bumped org.bouncycastle:bcprov-jdk18on:1.78.1 and org.bouncycastle:bcpkix-jdk18on:1.78.1 (#1246) (0557bed)

4.9.0 (2024-05-06)

New Features and Enhancements:

Bug Fixes:

  • Support create empty shared link (#1241) (0c86487)
  • Update exception message for get representation content (#1239) (a608f9a)

4.8.0 (2024-02-27)

New Features and Enhancements:

  • allow modifying BoxAPIRequest URL (#1236) (eaea019)
  • Bumped org.bouncycastle:bcprov-jdk18on:1.77 and org.bouncycastle:bcpkix-jdk18on:1.77 (#1237) (6c7fe7b), closes #1235

Bug Fixes:

  • fix download for empty files (#1231) (0e2230b)
  • stop using SharedLinkAPIConnection in getSharedItem() (#1234) (9f9af8e)

4.7.0 (2024-01-16)

New Features and Enhancements:

  • Add signer_group_id for signer in sign request (#1220) (f560db8)
  • Introduce IPrivateKeyDecryptor to allow using custom cryptography provider (#1226) (727e6d7)

Bug Fixes:

4.6.1 (2023-11-02)

Dependency Upgrades:

4.6.0 (2023-09-28)

New Features and Enhancements:

Bug Fixes:

  • Added protected accessors for trust manager and hostname verifier. (#1206) (0c79d17)
  • fix not closing response body (#1208) (ab5e170)

4.5.0 (2023-09-13)

New Features and Enhancements:

  • Add iframeable_embed_url field to BoxSignRequestSigner class (#1202) (2e931d8)

Bug Fixes:

4.4.0 (2023-08-29)

New Features and Enhancements:

  • Support sign template and new sign status (#1197) (e37c0dc)

4.3.0 (2023-08-11)

New Features and Enhancements:

4.2.1 (2023-08-03)

Bug Fixes:

4.2.0 (2023-06-21)

New Features and Enhancements:

  • Getting collaborators allows to specify fields (#1178) (1694d75)

4.1.2 (2023-06-14)

Bug Fixes:

4.1.1 (2023-05-16)

Bug Fixes:

  • Allow users to disable adding authentication header. (#1167) (3433e5a)
  • Logging headers when retrying request (#1164) (e0c3d8e)

4.1.0 (2023-04-24)

New Features and Enhancements:

  • Add missing fields parameter to create and update BoxUser methods (#1155) (be3820d), closes #1154

Bug Fixes:

  • Allow registering custom logger handlers (#1156) (7373d5c)
  • Fallback to default value of maxRetryAttempts when restoring BoxAPIConnection (#1161) (2a10e5d), closes #1160

4.0.1 (2023-03-06)

Bug Fixes:

  • OAUTH_SUFFIX gets appended twice to baseAuthorizationURL (#1148) (3164770), closes #1147
  • Wrong progress reported to ProgressListener by AbstractBoxMultipartRequest (#1151) (947ded3), closes #1149

4.0.0 (2023-01-17)

The most important change this release includes is the replacement of the HTTP library from a native one to OkHttp which allows SDK to

  • Support the HTTP2 version of the HTTP protocol.
  • Support proxies that do not use only basic authentication method. For details on creating custom proxy authenticators and an example of NTLM proxy authentication.

Breaking Changes

  • BatchAPIRequest – is no longer supported by the SDK
  • BoxAPIConnection#DEFAULT_MAX_ATTEMPTS is replaced with BoxAPIConnection#DEFAULT_MAX_RETRIES
  • BoxRedirectResponse – was removed and will not be replaced
  • BoxEvent.Type is replaced with EventType
  • Removing deprecated methods from BoxFile, BoxFileVersionRetention, BoxFolder, BoxGroup, BoxGroupMembership,BoxItem, BoxRetentionPolicy, BoxTask, BoxUser, BoxWebLink, EventLog, Metadata and MetadataTemplate.

Migration details can be found here.

New Features and Enhancements:

3.8.2 (2023-01-04)

Bug Fixes:

  • Fixed restoring state without refresh token. (#1139) (3544709)

3.8.1 (2022-12-19)

Bug Fixes:

  • Restoring state from previous SDK version works. (#1134) (b6d97dd)

3.8.0 (2022-11-15)

New Features and Enhancements:

Bug Fixes:

  • NullPointerException when using BoxSignRequestPrefillTag (#1121) (73fd5b6), closes #1120
  • Regenerate JWT ID and retry auth request when JTI claim is rejected (#1110) (420da0f)

Dependency Upgrades:

3.7.1 (2022-09-29)

Bug Fixes:

  • Better logging when JSON cannot be parsed (#1106) (5e66ef8)

3.7.0 (2022-09-20)

New Features and Enhancements:

  • Add is_accessible_via_shared_link field to File and Folder (#1103) (45e9906)

Bug Fixes:

  • BoxCollaboration.getItem() returns BoxItem.Info not BoxFolder.Info (#1102) (135850d), closes #1101 #1100. BoxCollaboration.getItem() used to return BoxFolder.Info. However, if collaboration was added on a file it would still return BoxFolder.Info which will end with throwing BoxAPIException when doing any API call. If you are getting collaboration item it is best to store it as BoxItem.Info or check its type and store it as BoxFile.Info or BoxFolder.Info.
  • Add missing constructor to BoxNotificationEmail class (#1098) (2534f34)

3.6.0 (2022-09-07)

New Features and Enhancements:

  • Add support for modifiable retention policies & enable deleting retention policy assignment (#1093) (30e2fcb)

Bug Fixes:

  • Stop sending not specified optional fields when creating a user (#1095) (b7d894d)

3.5.0 (2022-08-26)

New Features and Enhancements:

  • Add content-type sign request and response (#1087) (49411aa)
  • Add notification_email to BoxUser (#1088) (5477223)
  • Add redirect_url and declined_redirect_url to sign request response (#1089) (3921fe1)

Bug Fixes:

  • Fixed canceling sign request fails because of empty body (#1085) (32b8e79)

3.4.0 (2022-08-10)

New Features and Enhancements:

  • Added pagination for getting items in trash with new BoxTrash#items API (#1072) (9cd411d)

Bug Fixes:

  • buffered body write and fixed SDK logging (#1079) (bc35ef3)

3.3.0 (2022-07-01)

New Features and Enhancements:

Bug Fixes:

  • Fix closed stream exception in canUpload method (#1067) (543f91c)

3.2.1 (2022-06-10)

Bug Fixes:

3.2.0 (2022-05-23)

New Features and Enhancements:

3.1.2 (2022-03-22)

Bug Fixes:

  • Allow using As-User header with CCG Authentication (#1031) (b0c2389)
  • Fix retry logic when Retry-After header is present (#1033) (05224c4)

3.1.1 (2022-02-28)

Bug Fixes:

3.1.0 (2022-02-17)

New Features and Enhancements:

  • Added support for Client Credentials Grant authentication method (#1002) (9cfcaff)
  • API to extend disposition date on a file (#1001) (f3f6b60)
  • Deprecating indexName when executing metadata query (#1000) (c20dbbf)

Dependency Upgrades:

3.0.0 (2022-01-17)

⚠ BREAKING CHANGES

  • Changed BoxFileVersion class and removed fileVersion field (#978)
  • Removed deprecated API BoxCollaborationWhitelist replaced with BoxCollaborationAllowlist, BoxCollaborationWhitelistExemptTarget replaced with BoxCollaborationAllowlistExemptTarget (#969)
  • Dropping Java 7 support (#962)
  • Downgrading bouncycastle libraries to 1.57 (#942)

New Features and Enhancements:

  • Add typeName to BoxEvent that contains name of the event, even if it is not mapped to BoxEvent.EventType (#979) (b30f61f), closes #968
  • Add new optional description parameter to the retention_policies endpoint and start_date_field to the retention_policy_assignments endpoint. (#967) (0aa4ff4)
  • Adding BoxFile#getVersions(String... fields) to allow users to specify what information they want to extract. Fixes #946. (#947) (a2eb638)
  • Missing eventTypes from BoxAPI Documents. Fixes #974 (#975) (2c69360)
  • Removed deprecated API BoxCollaborationWhitelist replaced with BoxCollaborationAllowlist, BoxCollaborationWhitelistExemptTarget replaced with BoxCollaborationAllowlistExemptTarget (#969) (2fd4d6f)

Bug Fixes:

  • Changed BoxFileVersion class and removed fileVersion field (#978) (8c39451)
  • Changed SDK loggers name to "com.box.sdk", fixes #638 (#950) (443c230)
  • Date parsing error when BoxSignRequestPrefillTag created with date value. (#970) (cc2c8da)
  • Fix sending limit param in EventLog (#977) (96bdccc)
  • Fixed NullPointerException when empty metadata used on BoxFile or BoxFolder (#918) (#945) (68bc3c5)
  • Fixes issue (#951) error when deserialising sign request (#952) (070bdc5)

Dependency Upgrades:

[2.58.0] (2021-11-23)

⚠ BREAKING CHANGES

New Features and Enhancements:

  • SDK support for new GET /events stream_type: admin_logs_streaming (#938)
  • Adding BoxDeveloperEditionAPIConnection#getUserConnection to indicate that we can use this connection for managed users or app users (#940)

Bug Fixes:

  • Fix for deprecated enums still being used (#931)

[2.57.0] (2021-10-18)

⚠ BREAKING CHANGES

New Features and Enhancements:

  • Add support for marker-based paging in BoxFolder.getChildren (#927)
  • Upgraded minimal-json to v0.9.5
  • Upgraded jose4j to v0.7.9
  • Adding Gradle wrapper in version 4.0.1 (#928)

Bug Fixes:

  • Fix for infinite recursion (#924)
  • Fix unable to set Vanity URL on BoxSharedLink for BoxFile and BoxFolder (#925)

[2.56.0] (2021-08-31)

New Features and Enhancements:

  • Replace submaster GroupMembershipRole with coadmin. Replace MASTER_INVITE_ACCEPT and MASTER_INVITE_REJECT with ADMIN_INVITE_ACCEPT and ADMIN_INVITE_REJECT. (#907)
  • Add tracking_codes to create User API call (#910)

Bug Fixes:

  • Fix url for BoxFileRequest.Info object (#906)
  • Attempt to fix thread locking issue on refresh of access token (#912)

[2.55.1] (2021-07-30)

Bug Fixes:

  • Restore methods for Execute Metadata Query, which were removed in (#890), and mark them as deprecated (#905)

[2.55.0] (2021-07-26)

NOTE: Due to the benign nature of the "breaking change" below, we decided NOT to increment the major version for this release. There should be no customer impact due to this change.

⚠ BREAKING CHANGES

  • Update execute metadata query to match API response (#890)
    • NOTE: This change removes a method without deprecating it. It was not possible to use the method correctly at all, because the underlying service no longer supported it.

New Features and Enhancements:

  • Remove or deprecate insensitive language ([#889])(#889)
  • Add support for is_external_collab_restricted parameter for User (#896)
  • Add configurable permissions support for GroupMembership (#897)
  • Add SHIELD_JUSTIFICATION_APPROVAL event type (#898)
  • Add ability to get files under retention for assignment and file versions under retention for assignment (#899)
  • Add TASK_UPDATE, FILE_VERSION_RESTORE and ADVANCED_FOLDER_SETTINGS_UPDATE event types (#902)
  • Add SignAPI support (#904)

Bug Fixes:

  • Add setters for BoxLegalHoldPolicy (#885)
  • Add setters for BoxTaskAssignment (#886)
  • Add setters for Group Membership and Web Links (#887)
  • Add setters for Webhooks (#888)
  • Deprecate BoxFile.getThumbnail in favor of BoxFile.getRepresentationContent (#891)

[2.54.0] (2021-04-01)

New Features and Enhancements:

  • Add file request support (#869)

Bug Fixes:

  • Fix BoxWeblink deserialization (#881)

[2.53.0] (2021-01-08)

New Features and Enhancements:

  • Add offset and limit parameters to BoxFolder.getChildren (#861)

[2.52.0] (2020-11-24)

New Features and Enhancements:

  • Add folder lock functionality (#856)
  • Add support for search param to get shared link items (#855)

Bug Fixes:

  • Fix bug with updating tracking codes (#857)

[2.51.1] (2020-11-12)

Bug Fixes:

  • Fix for cross-enterprise collaborator calls to updateMetadata on files

[2.51.0] (2020-10-29)

New Features and Enhancements:

  • Add support for copyInstanceOnItemCopy field for metadata templates (#850)
  • Add support for more fields in BoxCollaborator.Info (#843)

Bug Fixes:

  • Update getAllGroupsByName() to use documented parameter (#851)

[2.50.1] (2020-08-20)

  • Fix bug that occurred when downscoping a token for a Box folder (#832)

[2.50.0] (2020-07-21)

  • API request creation errors are now retried with the same automatic retry logic as 429 and 5XX response errors (#828)

[2.49.0] (2020-07-17)

  • Fix bug with setting the unshared at date for a shared link (#819)
  • Add zip functionality (#825)
  • Add fields parameter for metadata query (#826)

[2.48.0] (2020-06-23)

  • Add ability to get groups by name with fields option (#789)
  • Add shared link downscoping (#785)
  • Deprecate the use of float for Metadata values, in preference of the underlying value (double) (#811)
  • Add iterator support for group collaborations (#813)
  • Add ability to set the filename when uploading a new version of a file (#810)
  • Add support for the classification field for Files and Folders (#809)
  • Add support for setting Tracking Codes (#766)
  • Fix issue for getIsExternallyOwned() for Files and Folders (#808)

[2.47.0] (2020-04-23)

  • Add support for the uploader display name field for Files and File Versions (#791)
  • Fix path parameter sanitization (#797)

[2.46.0] (2020-04-09)

  • Fix retry logic (#787)
    • Retry for 400 invalid_grant error in authentication requests (Clock Skew)
    • Honor Retry-After header, if present, by waiting for the time specified in the header before retrying
    • The concept of setting / getting "Maximum API Requests" has been deprecated in favor of "Maximum API Retries" to more clearly show the number of times a request will be retried after an error response is received.
  • Add ability to set expiration date for a collaboration (#788)
  • Add path parameter sanitization (#790)

[2.45.0] (2020-04-02)

  • Add preflight check before chunked uploads (#782)
  • Check that part was successfully uploaded for large file uploads before retrying for 500 errors (#781)
  • Fix bug with premature disconnect when renaming files and weblinks (#779)
  • Add metadata to each item returned by a metadata query (#778)

[2.44.1] (2020-02-13)

  • Fix formatting bug for Java Logger
  • Improve date / time parsing for responses

[2.44.0] (2020-01-21)

  • Fix Authentication Request Retries

[2.43.0] (2019-12-20)

  • Throw exceptions for setMetadata on Files and Folders for non-409 errors

[2.42.0] (2019-12-17)

  • Added Metadata Query support
  • Added marker based pagination for get users methods

[2.41.0] (2019-10-24)

  • Added enum action option for completed in Box Task class.

[2.40.0] (2019-10-24)

  • General doc changes.

[2.39.0] (2019-10-17)

[2.38.0] (2019-09-19)

[2.37.0] (2019-08-22)

  • Added support for replace in multi-select metadata for files and for folders
  • Improved getting started with JWT authentication docs that can be found here

[2.36.0] (2019-08-01)

  • Added support for removing shared link and fixed an issue with setting null for shared link field on BoxItem.
  • Added support for additional fields for Box files, folders, and web links.

[2.35.0] (2019-07-18)

[2.34.0] (2019-06-06)

  • Added support for retrieving a string type action for tasks. Please use getActionType() going forward instead of the deprecated getAction().

[2.33.0] (2019-05-23)

  • Added support for setting can_owners_invite field Thank you @Band-Aid for you pull request! Greatly Appreciated.
  • Fixed a bug where chunked upload was not populating the correct part size for upload part.

[2.32.0] (2019-04-25)

[2.31.0] (2019-04-11)

[2.30.1] (2019-04-08)

  • Fixed a bug where the SDK could throw when parsing JSON containing dates using the Zulu timezone format

[2.30.0] (2019-04-04)

  • Added action_by field to enterprise events stream.

[2.29.0] (2019-04-01)

[2.28.1] (2019-03-07)

  • Fixed a bug where BoxMetadataCascadePolicy.forceApply() would not return correctly.

[2.28.0] (2019-02-21)

[2.27.0] (2019-01-31)

  • Added support for Metadata Classification for File and Folder

[2.26.0] (2019-01-17)

[2.25.1] (2019-01-03)

  • Upgraded dependencies: jose4j to v0.5.5, and bouncycastle to v1.60

[2.25.0] (2018-12-13)

[2.24.0] (2018-11-16)

[2.23.2] (2018-09-27)

  • Fixed a bug where the specified headers for batch requests were not being sent.

[2.23.1] (2018-09-13)

  • Fixed a bug where too many TCP connections were being opened. Thank you @pmatte1 for implementing this fix!

[2.23.0] (2018-08-23)

[2.22.0] (2018-08-09)

[2.21.0] (2018-07-05)

  • Added functionality to allow users to set passwords on shared links for Box files, folders, and web links.
  • Fixed wrong redirect for two links in the Getting Started and Quick Test section of the README.

[2.20.2] (2018-06-28)

  • Fixed a bug where customers had issues with large file uploads because they fail to parse the Retry-After header from the commit response. Reason being headers storage/lookup was case sensitive.

[2.20.1] (2018-06-04)

  • Added better exception handling for JSON parse in response exception.
  • Fixed a bug where uploadNewVersion() was returning an empty object.

[2.20.0] (2018-05-24)

  • Fixed a bug where multiple As-User headers could be set.
  • Added support to test update for multiselect field on metadata

[2.19.0] (2018-05-10)

[2.18.0] (2018-04-30)

[2.17.0] (2018-04-10)

[2.16.1] (2018-03-29)

  • Added CONTENT_ACCESS to event type enum

[2.16.0] (2018-03-22)

  • Added support for user tracking codes on the user object.
  • Fixed a bug where JWT authentication would fail due to improper date parsing.
  • Added support for setting custom headers on API connection. This allow for setting As-User support and suppressing notifications support.
  • Changed default JWT expiration window to reduce chances of error.

[2.15.0] (2018-03-12)

[2.14.1] (2018-03-01)

  • Reduced the number of API calls that the EventStream makes to fetch new events, which should help users who are running into rate limit issues.
  • Force support for TLSv1.1 or higher when available to improve the security of connections to the Box API
  • Add randomized jitter to the exponential backoff algorithm used by the SDK to improve the success rate of retried requests.

[2.14.0] (2018-02-15)

  • Added support for getting and setting the can_view_path field on a collaboration object.
  • Added support for getting and setting the tags field on files and folders.

[2.13.0] (2018-02-07)

  • Fixed an issue where all types of metadata values were being coerced to Strings. This change deprecates Metadata#get() in favor of type-specific methods like Metadata#getFloat() or a generic Metadata#getValue(), which returns a JsonValue object that represents any JSON type. See the file metadata or folder metadata documentation for more information.

[2.12.0] (2018-02-01)

[2.11.0] (2018-01-25)

[2.10.0] (2018-01-11)

[2.9.0] (2018-01-04)

[2.8.2] (2017-10-05)

  • Added additional check for PrivateKeyInfo in BoxDeveloperEditionApiConnection

[2.8.1] (2017-10-05)

[2.8.0] (2017-09-07)

  • Added method for getting file representations
  • Changes to Representation object

[2.7.0] (2017-08-30)

[2.6.0] (2017-08-28)

[2.5.0] (2017-07-28)

[2.4.0] (2017-05-02)

  • Support for multiput upload. New methods in BoxFolder and BoxFile support multiput upload for better performance and reliability for large files.
  • Single file collaborations. The BoxFile class now supports sharing individual files.
  • Automatic configuration for JWT auth. The Box Developer console now lets you download a JSON file of your JWT app configuration settings. You can import this file into the Java SDK to easily configure your app.

[2.3.0] (2017-01-12)

New API Endpoints:

Legal Holds Retention Policies Create Metadata Template Get All Metadata on File Get All Metadata on Folder Get Enterprise Metadata Templates Update Group Watermarking Webhooks V2 WebLinks Collections BoxGroupMembership with for Paging Enterprise Device Pins

New Features:

Transactional Authentication. Support for Box's new Transactional Auth APIs. Upload file versions with SHA1. A file's SHA1 can be passed in to BoxFile.uploadVersion(...) when uploading new versions. Get effective_access for shared links. The effective_access field is accessible through BoxSharedLink. getEffectiveAccess(). Added additional Event Types. The TASK_ASSIGNMENT_COMPLETE, TASK_ASSIGNMENT_UPDATE, TASK_CREATE, COMMENT_DELETE types are now included in the BoxEvent class.

[2.1.0] (2016-02-22)

This release includes improvements to token caching for App Users and support for additional API endpoints.

New Features:

- App Users token caching. A token cache can now be specified in BoxDeveloperEditionAPIConnection. This allows for improved performance when using App Users authentication.
- Support for retrieving download URLs. The BoxFile.getDownloadURL() method allows for retrieving a direct download URL to a file.
- File thumbnails. The BoxFile.getThumbnail() method allows for downloading the [Thumbnail](https://github.com/box/box-java-sdk/blob/main/doc/files.md#get-thumbnail) for a file.

Bug Fixes:

- Getting info for a file could crash when there's no preview. Previously, an exception would be thrown if BoxFile.getInfo  (BoxFile.ALL_FIELDS) was called and the file didn't have a preview available.