SDK-5186: Mark class and constructors as deprecated

Author: bartek.zylinski

README.md

@@ -2,6 +2,12 @@
   <img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
 </p>
 
+# Deprecation notice
+
+This version of the Box Java SDK is under maintenance mode, and will be deprecated soon, only critical security updates and bug fixes will be provided. We recommend using the new version Box Java SDK, which can be found at [box/box-java-sdk-gen](https://github.com/box/box-java-sdk-gen)
+
+You can find the migration guide [here](https://github.com/box/box-java-sdk-gen/blob/main/migration-guide.md) for transitioning from Box Java SDK v3.x to the new `box-sdk-gen` package. If you have any questions, please create an issue in the new repository or reach out to [Box Developer Support](https://developer.box.com/support/).
+
 # Migration to v10
 
 The [sdk-gen](https://github.com/box/box-java-sdk/tree/sdk-gen) branch contains the generated code for the `v10` version of the Box Java SDK. This is intended primarily for developers migrating from [Box Java SDK Gen](https://github.com/box/box-java-sdk-gen) to the v10 version.
@@ -11,7 +17,7 @@ You can find the migration guide [here](https://github.com/box/box-java-sdk/blob
 
 # Box Java SDK
 
-[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
+[![Project Status](http://opensource.box.com/badges/stable.svg)](http://opensource.box.com/badges)
 ![Platform](https://img.shields.io/badge/java-%3E%3D8-blue)
 [![License](https://img.shields.io/badge/license-Apache2-blue)](https://raw.githubusercontent.com/box/box-java-sdk/main/LICENSE)
 [![Build main](https://github.com/box/box-java-sdk/actions/workflows/build-main.yml/badge.svg)](https://github.com/box/box-java-sdk/actions/workflows/build-main.yml)

src/main/java/com/box/sdk/BoxAPIConnection.java

@@ -37,13 +37,17 @@
 import okhttp3.Response;
 
 /**
+ * @deprecated
+ * This class, and the com.box.sdk package is deprecated, it is recommended to use com.box.sdkgen package.
+ *
  * Represents an authenticated connection to the Box API.
  *
  * <p>This class handles storing authentication information, automatic token refresh, and
  * rate-limiting. It can also be used to configure the Box API endpoint URL in order to hit a
  * different version of the API. Multiple instances of BoxAPIConnection may be created to support
  * multi-user login.
  */
+@Deprecated
 public class BoxAPIConnection {
 
   /**
@@ -136,22 +140,30 @@ public class BoxAPIConnection {
   private Authenticator authenticator;
 
   /**
+   * @deprecated
+   * This constructor, and the com.box.sdk package is deprecated, it is recommended to use com.box.sdkgen package.
+   *
    * Constructs a new BoxAPIConnection that authenticates with a developer or access token.
    *
    * @param accessToken a developer or access token to use for authenticating with the API.
    */
+  @Deprecated
   public BoxAPIConnection(String accessToken) {
     this(null, null, accessToken, null);
   }
 
   /**
+   * @deprecated
+   * This constructor, and the com.box.sdk package is deprecated, it is recommended to use com.box.sdkgen package.
+   *
    * Constructs a new BoxAPIConnection with an access token that can be refreshed.
    *
    * @param clientID the client ID to use when refreshing the access token.
    * @param clientSecret the client secret to use when refreshing the access token.
    * @param accessToken an initial access token to use for authenticating with the API.
    * @param refreshToken an initial refresh token to use when refreshing the access token.
    */
+  @Deprecated
   public BoxAPIConnection(
       String clientID, String clientSecret, String accessToken, String refreshToken) {
     this.clientID = clientID;
@@ -171,38 +183,50 @@ public BoxAPIConnection(
     this.userAgent = "Box Java SDK v" + SDK_VERSION + " (Java " + JAVA_VERSION + ")";
     this.listeners = new ArrayList<>();
     this.customHeaders = new HashMap<>();
-
+    System.err.println("Package boxsdk will be deprecated soon. Please use box-sdk-gen instead.");
     buildHttpClients();
   }
 
   /**
+   * @deprecated
+   * This constructor, and the com.box.sdk package is deprecated, it is recommended to use com.box.sdkgen package.
+   *
    * Constructs a new BoxAPIConnection with an auth code that was obtained from the first half of
    * OAuth.
    *
    * @param clientID the client ID to use when exchanging the auth code for an access token.
    * @param clientSecret the client secret to use when exchanging the auth code for an access token.
    * @param authCode an auth code obtained from the first half of the OAuth process.
    */
+  @Deprecated
   public BoxAPIConnection(String clientID, String clientSecret, String authCode) {
     this(clientID, clientSecret, null, null);
     this.authenticate(authCode);
   }
 
   /**
+   * @deprecated
+   * This constructor, and the com.box.sdk package is deprecated, it is recommended to use com.box.sdkgen package.
+   *
    * Constructs a new BoxAPIConnection.
    *
    * @param clientID the client ID to use when exchanging the auth code for an access token.
    * @param clientSecret the client secret to use when exchanging the auth code for an access token.
    */
+  @Deprecated
   public BoxAPIConnection(String clientID, String clientSecret) {
     this(clientID, clientSecret, null, null);
   }
 
   /**
-   * Constructs a new BoxAPIConnection levaraging BoxConfig.
+   * @deprecated
+   * This constructor, and the com.box.sdk package is deprecated, it is recommended to use com.box.sdkgen package.
+   *
+   * Constructs a new BoxAPIConnection leveraging BoxConfig.
    *
    * @param boxConfig BoxConfig file, which should have clientId and clientSecret
    */
+  @Deprecated
   public BoxAPIConnection(BoxConfig boxConfig) {
     this(boxConfig.getClientId(), boxConfig.getClientSecret(), null, null);
   }