Skip to content

chore(boxsdk): Mark com.box.sdk package as deprecated #1504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Pask423 merged 1 commit into from
Oct 16, 2025
Merged

chore(boxsdk): Mark com.box.sdk package as deprecated #1504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 35 additions & 18 deletions src/main/java/com/box/sdk/BoxAPIConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,16 @@
import okhttp3.Response;

/**
* 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 {@link BoxAPIConnection} class, and the entire the com.box.sdk package is deprecated,
* it is recommended to use {@link com.box.sdkgen} package. Instead of this class use {@link
* com.box.sdkgen.client.BoxClient}
* <p>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 {

/**
Expand Down Expand Up @@ -136,22 +139,28 @@ public class BoxAPIConnection {
private Authenticator authenticator;

/**
* Constructs a new BoxAPIConnection that authenticates with a developer or access token.
*
* @deprecated {@link BoxAPIConnection} class, and the entire com.box.sdk package is deprecated,
* it is recommended to use {@link com.box.sdkgen} package. Instead of this class use {@link
* com.box.sdkgen.client.BoxClient}
* <p>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);
}

/**
* Constructs a new BoxAPIConnection with an access token that can be refreshed.
*
* @deprecated {@link BoxAPIConnection} class, and the entire com.box.sdk package is deprecated,
* it is recommended to use {@link com.box.sdkgen} package. Instead of this class use {@link
* com.box.sdkgen.client.BoxClient}
* <p>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;
Expand All @@ -171,38 +180,46 @@ public BoxAPIConnection(
this.userAgent = "Box Java SDK v" + SDK_VERSION + " (Java " + JAVA_VERSION + ")";
this.listeners = new ArrayList<>();
this.customHeaders = new HashMap<>();

buildHttpClients();
}

/**
* Constructs a new BoxAPIConnection with an auth code that was obtained from the first half of
* OAuth.
*
* @deprecated {@link BoxAPIConnection} class, and the entire com.box.sdk package is deprecated,
* it is recommended to use {@link com.box.sdkgen} package. Instead of this class use {@link
* com.box.sdkgen.client.BoxClient}
* <p>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);
}

/**
* Constructs a new BoxAPIConnection.
*
* @deprecated {@link BoxAPIConnection} class, and the entire com.box.sdk package is deprecated,
* it is recommended to use {@link com.box.sdkgen} package. Instead of this class use {@link
* com.box.sdkgen.client.BoxClient}
* <p>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 {@link BoxAPIConnection} class, and the entire com.box.sdk package is deprecated,
* it is recommended to use {@link com.box.sdkgen} package. Instead of this class use {@link
* com.box.sdkgen.client.BoxClient}
* <p>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);
}
Expand Down