+
+
+
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.
- */ -public class BoxAPIConnection { - /** - * The default maximum number of times an API request will be tried when an error occurs. - */ - public static final int DEFAULT_MAX_ATTEMPTS = 3; - - private static final String TOKEN_URL_STRING = "https://www.box.com/api/oauth2/token"; - private static final String DEFAULT_BASE_URL = "https://api.box.com/2.0/"; - private static final String DEFAULT_BASE_UPLOAD_URL = "https://upload.box.com/api/2.0/"; - - /** - * The amount of buffer time, in milliseconds, to use when determining if an access token should be refreshed. For - * example, if REFRESH_EPSILON = 60000 and the access token expires in less than one minute, it will be refreshed. - */ - private static final long REFRESH_EPSILON = 60000; - - private final String clientID; - private final String clientSecret; - private final ReadWriteLock refreshLock; - - // These volatile fields are used when determining if the access token needs to be refreshed. Since they are used in - // the double-checked lock in getAccessToken(), they must be atomic. - private volatile long lastRefresh; - private volatile long expires; - - private String userAgent; - private String accessToken; - private String refreshToken; - private String tokenURL; - private String baseURL; - private String baseUploadURL; - private boolean autoRefresh; - private int maxRequestAttempts; - private ListgetAccessToken().
- * @return a valid access token that can be used to authenticate an API request.
- */
- public String getAccessToken() {
- if (this.autoRefresh && this.canRefresh() && this.needsRefresh()) {
- this.refreshLock.writeLock().lock();
- try {
- if (this.needsRefresh()) {
- this.refresh();
- }
- } finally {
- this.refreshLock.writeLock().unlock();
- }
- }
-
- return this.accessToken;
- }
-
- /**
- * Sets the access token to use when authenticating API requests.
- * @param accessToken a valid access token to use when authenticating API requests.
- */
- public void setAccessToken(String accessToken) {
- this.accessToken = accessToken;
- }
-
- /**
- * Gets a refresh token that can be used to refresh an access token.
- * @return a valid refresh token.
- */
- public String getRefreshToken() {
- return this.refreshToken;
- }
-
- /**
- * Sets the refresh token to use when refreshing an access token.
- * @param refreshToken a valid refresh token.
- */
- public void setRefreshToken(String refreshToken) {
- this.refreshToken = refreshToken;
- }
-
- /**
- * Enables or disables automatic refreshing of this connection's access token. Defaults to true.
- * @param autoRefresh true to enable auto token refresh; otherwise false.
- */
- public void setAutoRefresh(boolean autoRefresh) {
- this.autoRefresh = autoRefresh;
- }
-
- /**
- * Gets whether or not automatic refreshing of this connection's access token is enabled. Defaults to true.
- * @return true if auto token refresh is enabled; otherwise false.
- */
- public boolean getAutoRefresh() {
- return this.autoRefresh;
- }
-
- /**
- * Gets the maximum number of times an API request will be tried when an error occurs.
- * @return the maximum number of request attempts.
- */
- public int getMaxRequestAttempts() {
- return this.maxRequestAttempts;
- }
-
- /**
- * Sets the maximum number of times an API request will be tried when an error occurs.
- * @param attempts the maximum number of request attempts.
- */
- public void setMaxRequestAttempts(int attempts) {
- this.maxRequestAttempts = attempts;
- }
-
- /**
- * Determines if this connection's access token can be refreshed. An access token cannot be refreshed if a refresh
- * token was never set.
- * @return true if the access token can be refreshed; otherwise false.
- */
- public boolean canRefresh() {
- return this.refreshToken != null;
- }
-
- /**
- * Determines if this connection's access token has expired and needs to be refreshed.
- * @return true if the access token needs to be refreshed; otherwise false.
- */
- public boolean needsRefresh() {
- boolean needsRefresh;
-
- this.refreshLock.readLock().lock();
- if (this.expires == 0) {
- needsRefresh = false;
- } else {
- long now = System.currentTimeMillis();
- long tokenDuration = (now - this.lastRefresh);
- needsRefresh = (tokenDuration >= this.expires - REFRESH_EPSILON);
- }
- this.refreshLock.readLock().unlock();
-
- return needsRefresh;
- }
-
- /**
- * Refresh's this connection's access token using its refresh token.
- * @throws IllegalStateException if this connection's access token cannot be refreshed.
- */
- public void refresh() {
- this.refreshLock.writeLock().lock();
-
- if (!this.canRefresh()) {
- this.refreshLock.writeLock().unlock();
- throw new IllegalStateException("The BoxAPIConnection cannot be refreshed because it doesn't have a "
- + "refresh token.");
- }
-
- URL url = null;
- try {
- url = new URL(this.tokenURL);
- } catch (MalformedURLException e) {
- this.refreshLock.writeLock().unlock();
- assert false : "An invalid refresh URL indicates a bug in the SDK.";
- throw new RuntimeException("An invalid refresh URL indicates a bug in the SDK.", e);
- }
-
- String urlParameters = String.format("grant_type=refresh_token&refresh_token=%s&client_id=%s&client_secret=%s",
- this.refreshToken, this.clientID, this.clientSecret);
-
- BoxAPIRequest request = new BoxAPIRequest(url, "POST");
- request.addHeader("Content-Type", "application/x-www-form-urlencoded");
- request.setBody(urlParameters);
-
- String json;
- try {
- BoxJSONResponse response = (BoxJSONResponse) request.send();
- json = response.getJSON();
- } catch (BoxAPIException e) {
- this.refreshLock.writeLock().unlock();
- throw e;
- }
-
- JsonObject jsonObject = JsonObject.readFrom(json);
- this.accessToken = jsonObject.get("access_token").asString();
- this.refreshToken = jsonObject.get("refresh_token").asString();
- this.lastRefresh = System.currentTimeMillis();
- this.expires = jsonObject.get("expires_in").asLong() * 1000;
-
- this.notifyRefresh();
-
- this.refreshLock.writeLock().unlock();
- }
-
- /**
- * Notifies refresh event to all the listeners.
- */
- private void notifyRefresh() {
- for (BoxAPIConnectionListener listener : this.listeners) {
- listener.onRefresh();
- }
- }
-
- /**
- * Add a listener to listen to Box API connection events.
- * @param listener a listener to listen to Box API connection.
- */
- public void addListener(BoxAPIConnectionListener listener) {
- this.listeners.add(listener);
- }
-
- /**
- * Remove a listener listening to Box API connection events.
- * @param listener the listener to remove.
- */
- public void removeListener(BoxAPIConnectionListener listener) {
- this.listeners.remove(listener);
- }
-
- /**
- * Gets the RequestInterceptor associated with this API connection.
- * @return the RequestInterceptor associated with this API connection.
- */
- public RequestInterceptor getRequestInterceptor() {
- return this.interceptor;
- }
-
- /**
- * Sets a RequestInterceptor that can intercept requests and manipulate them before they're sent to the Box API.
- * @param interceptor the RequestInterceptor.
- */
- public void setRequestInterceptor(RequestInterceptor interceptor) {
- this.interceptor = interceptor;
- }
-}
diff --git a/src/main/java/com/box/sdk/BoxAPIConnectionListener.java b/src/main/java/com/box/sdk/BoxAPIConnectionListener.java
deleted file mode 100644
index c2f2996db..000000000
--- a/src/main/java/com/box/sdk/BoxAPIConnectionListener.java
+++ /dev/null
@@ -1,12 +0,0 @@
-package com.box.sdk;
-
-/**
- * Listener to listen to Box API connection events.
- */
-public interface BoxAPIConnectionListener {
-
- /**
- * Called when the Box API connection refreshes its tokens.
- */
- void onRefresh();
-}
diff --git a/src/main/java/com/box/sdk/BoxAPIException.java b/src/main/java/com/box/sdk/BoxAPIException.java
deleted file mode 100644
index 4d30d6c97..000000000
--- a/src/main/java/com/box/sdk/BoxAPIException.java
+++ /dev/null
@@ -1,77 +0,0 @@
-package com.box.sdk;
-
-/**
- * Thrown to indicate that an error occurred while communicating with the Box API.
- */
-public class BoxAPIException extends RuntimeException {
- private static final long serialVersionUID = 1L;
-
- private final int responseCode;
- private final String response;
-
- /**
- * Constructs a BoxAPIException with a specified message.
- * @param message a message explaining why the exception occurred.
- */
- public BoxAPIException(String message) {
- super(message);
-
- this.responseCode = 0;
- this.response = null;
- }
-
- /**
- * Constructs a BoxAPIException with details about the server's response.
- * @param message a message explaining why the exception occurred.
- * @param responseCode the response code returned by the Box server.
- * @param response the response body returned by the Box server.
- */
- public BoxAPIException(String message, int responseCode, String response) {
- super(message);
-
- this.responseCode = responseCode;
- this.response = response;
- }
-
- /**
- * Constructs a BoxAPIException that wraps another underlying exception.
- * @param message a message explaining why the exception occurred.
- * @param cause an underlying exception.
- */
- public BoxAPIException(String message, Throwable cause) {
- super(message, cause);
-
- this.responseCode = 0;
- this.response = null;
- }
-
- /**
- * Constructs a BoxAPIException that wraps another underlying exception with details about the server's response.
- * @param message a message explaining why the exception occurred.
- * @param responseCode the response code returned by the Box server.
- * @param response the response body returned by the Box server.
- * @param cause an underlying exception.
- */
- public BoxAPIException(String message, int responseCode, String response, Throwable cause) {
- super(message, cause);
-
- this.responseCode = responseCode;
- this.response = response;
- }
-
- /**
- * Gets the response code returned by the server when this exception was thrown.
- * @return the response code returned by the server.
- */
- public int getResponseCode() {
- return this.responseCode;
- }
-
- /**
- * Gets the body of the response returned by the server when this exception was thrown.
- * @return the body of the response returned by the server.
- */
- public String getResponse() {
- return this.response;
- }
-}
diff --git a/src/main/java/com/box/sdk/BoxAPIRequest.java b/src/main/java/com/box/sdk/BoxAPIRequest.java
deleted file mode 100644
index ba1210ca8..000000000
--- a/src/main/java/com/box/sdk/BoxAPIRequest.java
+++ /dev/null
@@ -1,471 +0,0 @@
-package com.box.sdk;
-
-import java.io.ByteArrayInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.net.HttpURLConnection;
-import java.net.MalformedURLException;
-import java.net.ProtocolException;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.logging.Level;
-import java.util.logging.Logger;
-
-/**
- * Used to make HTTP requests to the Box API.
- *
- * All requests to the REST API are sent using this class or one of its subclasses. This class wraps {@link - * HttpURLConnection} in order to provide a simpler interface that can automatically handle various conditions specific - * to Box's API. Requests will be authenticated using a {@link BoxAPIConnection} (if one is provided), so it isn't - * necessary to add authorization headers. Requests can also be sent more than once, unlike with HttpURLConnection. If - * an error occurs while sending a request, it will be automatically retried (with a back off delay) up to the maximum - * number of times set in the BoxAPIConnection.
- * - *Specifying a body for a BoxAPIRequest is done differently than it is with HttpURLConnection. Instead of writing to - * an OutputStream, the request is provided an {@link InputStream} which will be read when the {@link #send} method is - * called. This makes it easy to retry requests since the stream can automatically reset and reread with each attempt. - * If the stream cannot be reset, then a new stream will need to be provided before each call to send. There is also a - * convenience method for specifying the body as a String, which simply wraps the String with an InputStream.
- */ -public class BoxAPIRequest { - private static final Logger LOGGER = Logger.getLogger(BoxAPIRequest.class.getName()); - private static final int BUFFER_SIZE = 8192; - private static final int MAX_REDIRECTS = 3; - - private final BoxAPIConnection api; - private final ListThe stream must support the {@link InputStream#reset} method if auto-retry is used or if the request needs to - * be resent. Otherwise, the body must be manually set before each call to {@link #send}.
- * - * @param stream an InputStream containing the contents of the body. - */ - public void setBody(InputStream stream) { - this.body = stream; - } - - /** - * Sets the request body to the contents of an InputStream. - * - *Providing the length of the InputStream allows for the progress of the request to be monitored when calling - * {@link #send(ProgressListener)}.
- * - *See {@link #setBody(InputStream)} for more information on setting the body of the request.
- * - * @param stream an InputStream containing the contents of the body. - * @param length the expected length of the stream. - */ - public void setBody(InputStream stream, long length) { - this.bodyLength = length; - this.body = stream; - } - - /** - * Sets the request body to the contents of a String. - * - *If the contents of the body are large, then it may be more efficient to use an {@link InputStream} instead of - * a String. Using a String requires that the entire body be in memory before sending the request.
- * - * @param body a String containing the contents of the body. - */ - public void setBody(String body) { - byte[] bytes = body.getBytes(StandardCharsets.UTF_8); - this.bodyLength = bytes.length; - this.body = new ByteArrayInputStream(bytes); - } - - /** - * Sends this request and returns a BoxAPIResponse containing the server's response. - * - *The type of the returned BoxAPIResponse will be based on the content type returned by the server, allowing it - * to be cast to a more specific type. For example, if it's known that the API call will return a JSON response, - * then it can be cast to a {@link BoxJSONResponse} like so:
- * - *BoxJSONResponse response = (BoxJSONResponse) request.send();- * - *
If the server returns an error code or if a network error occurs, then the request will be automatically - * retried. If the maximum number of retries is reached and an error still occurs, then a {@link BoxAPIException} - * will be thrown.
- * - * @throws BoxAPIException if the server returns an error code or if a network error occurs. - * @return a {@link BoxAPIResponse} containing the server's response. - */ - public BoxAPIResponse send() { - return this.send(null); - } - - /** - * Sends this request while monitoring its progress and returns a BoxAPIResponse containing the server's response. - * - *A ProgressListener is generally only useful when the size of the request is known beforehand. If the size is - * unknown, then the ProgressListener will be updated for each byte sent, but the total number of bytes will be - * reported as 0.
- * - *
See {@link #send} for more information on sending requests.
- * - * @param listener a listener for monitoring the progress of the request. - * @throws BoxAPIException if the server returns an error code or if a network error occurs. - * @return a {@link BoxAPIResponse} containing the server's response. - */ - public BoxAPIResponse send(ProgressListener listener) { - if (this.api == null) { - this.backoffCounter.reset(BoxAPIConnection.DEFAULT_MAX_ATTEMPTS); - } else { - this.backoffCounter.reset(this.api.getMaxRequestAttempts()); - } - - while (this.backoffCounter.getAttemptsRemaining() > 0) { - try { - return this.trySend(listener); - } catch (BoxAPIException apiException) { - if (!this.backoffCounter.decrement() || !isResponseRetryable(apiException.getResponseCode())) { - throw apiException; - } - - try { - this.resetBody(); - } catch (IOException ioException) { - throw apiException; - } - - try { - this.backoffCounter.waitBackoff(); - } catch (InterruptedException interruptedException) { - Thread.currentThread().interrupt(); - throw apiException; - } - } - } - - throw new RuntimeException(); - } - - /** - * Returns a String containing the URL, HTTP method, headers and body of this request. - * @return a String containing information about this request. - */ - @Override - public String toString() { - String lineSeparator = System.getProperty("line.separator"); - StringBuilder builder = new StringBuilder(); - builder.append("Request"); - builder.append(lineSeparator); - builder.append(this.method); - builder.append(' '); - builder.append(this.url.toString()); - builder.append(lineSeparator); - - for (Map.EntryA subclass may want override this method if the body can be converted to a String for logging or debugging - * purposes.
- * - * @return a String representation of this request's body. - */ - protected String bodyToString() { - return null; - } - - /** - * Writes the body of this request to an HttpURLConnection. - * - *Subclasses overriding this method must remember to close the connection's OutputStream after writing.
- * - * @param connection the connection to which the body should be written. - * @param listener an optional listener for monitoring the write progress. - * @throws BoxAPIException if an error occurs while writing to the connection. - */ - protected void writeBody(HttpURLConnection connection, ProgressListener listener) { - if (this.body == null) { - return; - } - - connection.setDoOutput(true); - try { - OutputStream output = connection.getOutputStream(); - if (listener != null) { - output = new ProgressOutputStream(output, listener, this.bodyLength); - } - int b = this.body.read(); - while (b != -1) { - output.write(b); - b = this.body.read(); - } - output.close(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - } - - /** - * Resets the InputStream containing this request's body. - * - *This method will be called before each attempt to resend the request, giving subclasses an opportunity to - * reset any streams that need to be read when sending the body.
- * - * @throws IOException if the stream cannot be reset. - */ - protected void resetBody() throws IOException { - if (this.body != null) { - this.body.reset(); - } - } - - void setBackoffCounter(BackoffCounter counter) { - this.backoffCounter = counter; - } - - private BoxAPIResponse trySend(ProgressListener listener) { - if (this.api != null) { - RequestInterceptor interceptor = this.api.getRequestInterceptor(); - if (interceptor != null) { - BoxAPIResponse response = interceptor.onRequest(this); - if (response != null) { - return response; - } - } - } - - HttpURLConnection connection = this.createConnection(); - - if (this.bodyLength > 0) { - connection.setFixedLengthStreamingMode((int) this.bodyLength); - connection.setDoOutput(true); - } - - if (this.api != null) { - connection.addRequestProperty("Authorization", "Bearer " + this.api.getAccessToken()); - connection.setRequestProperty("User-Agent", this.api.getUserAgent()); - - if (this.api instanceof SharedLinkAPIConnection) { - SharedLinkAPIConnection sharedItemAPI = (SharedLinkAPIConnection) this.api; - String sharedLink = sharedItemAPI.getSharedLink(); - String boxAPIValue = "shared_link=" + sharedLink; - String sharedLinkPassword = sharedItemAPI.getSharedLinkPassword(); - if (sharedLinkPassword != null) { - boxAPIValue += "&shared_link_password=" + sharedLinkPassword; - } - connection.addRequestProperty("BoxApi", boxAPIValue); - } - } - - this.requestProperties = connection.getRequestProperties(); - this.writeBody(connection, listener); - - // Ensure that we're connected in case writeBody() didn't write anything. - try { - connection.connect(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - - this.logRequest(connection); - - // We need to manually handle redirects by creating a new HttpURLConnection so that connection pooling happens - // correctly. There seems to be a bug in Oracle's Java implementation where automatically handled redirects will - // not keep the connection alive. - int responseCode; - try { - responseCode = connection.getResponseCode(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - if (isResponseRedirect(responseCode)) { - return this.handleRedirect(connection, listener); - } - - String contentType = connection.getContentType(); - BoxAPIResponse response; - if (contentType == null) { - response = new BoxAPIResponse(connection); - } else if (contentType.contains("application/json")) { - response = new BoxJSONResponse(connection); - } else { - response = new BoxAPIResponse(connection); - } - - return response; - } - - private BoxAPIResponse handleRedirect(HttpURLConnection connection, ProgressListener listener) { - if (this.numRedirects >= MAX_REDIRECTS) { - throw new BoxAPIException("The Box API responded with too many redirects."); - } - this.numRedirects++; - - // Even though the redirect response won't have a body, we need to read the InputStream so that Java will put - // the connection back in the connection pool. - try { - InputStream stream = connection.getInputStream(); - byte[] buffer = new byte[8192]; - int n = stream.read(buffer); - while (n != -1) { - n = stream.read(buffer); - } - stream.close(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - - String redirect = connection.getHeaderField("Location"); - try { - this.url = new URL(redirect); - } catch (MalformedURLException e) { - throw new BoxAPIException("The Box API responded with an invalid redirect.", e); - } - return this.trySend(listener); - } - - private void logRequest(HttpURLConnection connection) { - if (LOGGER.isLoggable(Level.FINE)) { - LOGGER.log(Level.FINE, this.toString()); - } - } - - private HttpURLConnection createConnection() { - HttpURLConnection connection = null; - - try { - connection = (HttpURLConnection) this.url.openConnection(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - - try { - connection.setRequestMethod(this.method); - } catch (ProtocolException e) { - throw new BoxAPIException("Couldn't connect to the Box API because the request's method was invalid.", e); - } - - connection.setConnectTimeout(this.timeout); - connection.setReadTimeout(this.timeout); - - // Don't allow HttpURLConnection to automatically redirect because it messes up the connection pool. See the - // trySend(ProgressListener) method for how we handle redirects. - connection.setInstanceFollowRedirects(false); - - for (RequestHeader header : this.headers) { - connection.addRequestProperty(header.getKey(), header.getValue()); - } - - return connection; - } - - private static boolean isResponseRetryable(int responseCode) { - return (responseCode >= 500 || responseCode == 429); - } - - private static boolean isResponseRedirect(int responseCode) { - return (responseCode == 301 || responseCode == 302); - } - - private final class RequestHeader { - private final String key; - private final String value; - - public RequestHeader(String key, String value) { - this.key = key; - this.value = value; - } - - public String getKey() { - return this.key; - } - - public String getValue() { - return this.value; - } - } -} diff --git a/src/main/java/com/box/sdk/BoxAPIResponse.java b/src/main/java/com/box/sdk/BoxAPIResponse.java deleted file mode 100644 index 0b1204481..000000000 --- a/src/main/java/com/box/sdk/BoxAPIResponse.java +++ /dev/null @@ -1,258 +0,0 @@ -package com.box.sdk; - -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.net.HttpURLConnection; -import java.util.ArrayList; -import java.util.List; -import java.util.Map; -import java.util.logging.Level; -import java.util.logging.Logger; -import java.util.zip.GZIPInputStream; - -/** - * Used to read HTTP responses from the Box API. - * - *All responses from the REST API are read using this class or one of its subclasses. This class wraps {@link - * HttpURLConnection} in order to provide a simpler interface that can automatically handle various conditions specific - * to Box's API. When a response is contructed, it will throw a {@link BoxAPIException} if the response from the API - * was an error. Therefore every BoxAPIResponse instance is guaranteed to represent a successful response.
- * - *This class usually isn't instantiated directly, but is instead returned after calling {@link BoxAPIRequest#send}. - *
- */ -public class BoxAPIResponse { - private static final Logger LOGGER = Logger.getLogger(BoxAPIResponse.class.getName()); - private static final int BUFFER_SIZE = 8192; - - private final HttpURLConnection connection; - - private int responseCode; - private String bodyString; - - /** - * The raw InputStream is the stream returned directly from HttpURLConnection.getInputStream(). We need to keep - * track of this stream in case we need to access it after wrapping it inside another stream. - */ - private InputStream rawInputStream; - - /** - * The regular InputStream is the stream that will be returned by getBody(). This stream might be a GZIPInputStream - * or a ProgressInputStream (or both) that wrap the raw InputStream. - */ - private InputStream inputStream; - - /** - * Constructs an empty BoxAPIResponse without an associated HttpURLConnection. - */ - public BoxAPIResponse() { - this.connection = null; - } - - /** - * Constructs a BoxAPIResponse using an HttpURLConnection. - * @param connection a connection that has already sent a request to the API. - */ - public BoxAPIResponse(HttpURLConnection connection) { - this.connection = connection; - this.inputStream = null; - - try { - this.responseCode = this.connection.getResponseCode(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - - if (!isSuccess(this.responseCode)) { - this.logResponse(); - throw new BoxAPIException("The API returned an error code: " + this.responseCode, this.responseCode, - this.bodyToString()); - } - - this.logResponse(); - } - - /** - * Gets the response code returned by the API. - * @return the response code returned by the API. - */ - public int getResponseCode() { - return this.responseCode; - } - - /** - * Gets the length of this response's body as indicated by the "Content-Length" header. - * @return the length of the response's body. - */ - public long getContentLength() { - return this.connection.getContentLength(); - } - - /** - * Gets an InputStream for reading this response's body. - * @return an InputStream for reading the response's body. - */ - public InputStream getBody() { - return this.getBody(null); - } - - /** - * Gets an InputStream for reading this response's body which will report its read progress to a ProgressListener. - * @param listener a listener for monitoring the read progress of the body. - * @return an InputStream for reading the response's body. - */ - public InputStream getBody(ProgressListener listener) { - if (this.inputStream == null) { - String contentEncoding = this.connection.getContentEncoding(); - try { - if (this.rawInputStream == null) { - this.rawInputStream = this.connection.getInputStream(); - } - - if (listener == null) { - this.inputStream = this.rawInputStream; - } else { - this.inputStream = new ProgressInputStream(this.rawInputStream, listener, - this.getContentLength()); - } - - if (contentEncoding != null && contentEncoding.equalsIgnoreCase("gzip")) { - this.inputStream = new GZIPInputStream(this.inputStream); - } - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - } - - return this.inputStream; - } - - /** - * Disconnects this response from the server and frees up any network resources. The body of this response can no - * longer be read after it has been disconnected. - */ - public void disconnect() { - try { - if (this.rawInputStream == null) { - this.rawInputStream = this.connection.getInputStream(); - } - - // We need to manually read from the raw input stream in case there are any remaining bytes. There's a bug - // where a wrapping GZIPInputStream may not read to the end of a chunked response, causing Java to not - // return the connection to the connection pool. - byte[] buffer = new byte[BUFFER_SIZE]; - int n = this.rawInputStream.read(buffer); - while (n != -1) { - n = this.rawInputStream.read(buffer); - } - this.rawInputStream.close(); - - if (this.inputStream != null) { - this.inputStream.close(); - } - } catch (IOException e) { - throw new BoxAPIException("Couldn't finish closing the connection to the Box API due to a network error or " - + "because the stream was already closed.", e); - } - } - - @Override - public String toString() { - String lineSeparator = System.getProperty("line.separator"); - MapUnless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxCollaboration extends BoxResource { - private static final URLTemplate COLLABORATIONS_URL_TEMPLATE = new URLTemplate("collaborations"); - private static final URLTemplate PENDING_COLLABORATIONS_URL = new URLTemplate("collaborations?status=pending"); - private static final URLTemplate COLLABORATION_URL_TEMPLATE = new URLTemplate("collaborations/%s"); - - /** - * Constructs a BoxCollaboration for a collaboration with a given ID. - * @param api the API connection to be used by the collaboration. - * @param id the ID of the collaboration. - */ - public BoxCollaboration(BoxAPIConnection api, String id) { - super(api, id); - } - - /** - * Gets all pending collaboration invites for the current user. - * @param api the API connection to use. - * @return a collection of pending collaboration infos. - */ - public static CollectionUnless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxComment extends BoxResource { - private static final Pattern MENTION_REGEX = Pattern.compile("@\\[.+:.+\\]"); - private static final URLTemplate ADD_COMMENT_URL_TEMPLATE = new URLTemplate("comments"); - private static final URLTemplate COMMENT_URL_TEMPLATE = new URLTemplate("comments/%s"); - - /** - * Constructs a BoxComment for a comment with a given ID. - * @param api the API connection to be used with the comment. - * @param id the ID of the comment. - */ - public BoxComment(BoxAPIConnection api, String id) { - super(api, id); - } - - /** - * Determines if a comment message contains an @mention. - * @param message the comment message. - * @return true if the message contains an @mention; otherwise false. - */ - static boolean messageContainsMention(String message) { - return MENTION_REGEX.matcher(message).find(); - } - - /** - * Gets information about this comment. - * @return info about this comment. - */ - public Info getInfo() { - URL url = COMMENT_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "GET"); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject jsonResponse = JsonObject.readFrom(response.getJSON()); - - return new Info(jsonResponse); - } - - /** - * Changes the message of this comment. - * @param newMessage the new message for this comment. - * @return updated info about this comment. - */ - public Info changeMessage(String newMessage) { - Info newInfo = new Info(); - newInfo.setMessage(newMessage); - - URL url = COMMENT_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT"); - request.setBody(newInfo.getPendingChanges()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject jsonResponse = JsonObject.readFrom(response.getJSON()); - - return new Info(jsonResponse); - } - - /** - * Replies to this comment with another message. - * @param message the message for the reply. - * @return info about the newly created reply comment. - */ - public BoxComment.Info reply(String message) { - JsonObject itemJSON = new JsonObject(); - itemJSON.add("type", "comment"); - itemJSON.add("id", this.getID()); - - JsonObject requestJSON = new JsonObject(); - requestJSON.add("item", itemJSON); - if (BoxComment.messageContainsMention(message)) { - requestJSON.add("tagged_message", message); - } else { - requestJSON.add("message", message); - } - - URL url = ADD_COMMENT_URL_TEMPLATE.build(this.getAPI().getBaseURL()); - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "POST"); - request.setBody(requestJSON.toString()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject responseJSON = JsonObject.readFrom(response.getJSON()); - - BoxComment addedComment = new BoxComment(this.getAPI(), responseJSON.get("id").asString()); - return addedComment.new Info(responseJSON); - } - - /** - * Deletes this comment. - */ - public void delete() { - URL url = COMMENT_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "DELETE"); - BoxAPIResponse response = request.send(); - response.disconnect(); - } - - /** - * Contains information about a BoxComment. - */ - public class Info extends BoxResource.Info { - private boolean isReplyComment; - private String message; - private String taggedMessage; - private BoxUser.Info createdBy; - private Date createdAt; - private BoxResource.Info item; - private BoxUser.Info modifiedBy; - - /** - * Constructs an empty Info object. - */ - public Info() { - super(); - } - - /** - * Constructs an Info object by parsing information from a JSON string. - * @param json the JSON string to parse. - */ - public Info(String json) { - super(json); - } - - /** - * Constructs an Info object using an already parsed JSON object. - * @param jsonObject the parsed JSON object. - */ - Info(JsonObject jsonObject) { - super(jsonObject); - } - - /** - * Gets whether or not the comment is a reply to another comment. - * @return true if this comment is a reply to another comment; otherwise false. - */ - public boolean getIsReplyComment() { - return this.isReplyComment; - } - - /** - * Gets the comment's message. - * @return the comment's message. - */ - public String getMessage() { - if (this.taggedMessage != null) { - return this.taggedMessage; - } - - return this.message; - } - - /** - * Sets the comment's message. The message can contain @mentions by using the string @[userid:username] anywhere - * within the message, where userid and username are the ID and username of the person being mentioned. - * @param message the comment's new message. - */ - public void setMessage(String message) { - if (messageContainsMention(message)) { - this.taggedMessage = message; - this.addPendingChange("tagged_message", message); - this.removePendingChange("message"); - } else { - this.message = message; - this.addPendingChange("message", message); - this.removePendingChange("tagged_message"); - } - } - - /** - * Gets info about the user who created the comment. - * @return info about the user who created the comment. - */ - public BoxUser.Info getCreatedBy() { - return this.createdBy; - } - - /** - * Gets the time the comment was created. - * @return the time the comment was created. - */ - public Date getCreatedAt() { - return this.createdAt; - } - - /** - * Gets info about the item this comment is attached to. If the comment is a reply, then the item will be - * another BoxComment. Otherwise, the item will be a {@link BoxFile}. - * @return the item this comment is attached to. - */ - public BoxResource.Info getItem() { - return this.item; - } - - /** - * Gets info about the user who last modified the comment. - * @return info about the user who last modified the comment. - */ - public BoxUser.Info getModifiedBy() { - return this.modifiedBy; - } - - @Override - public BoxComment getResource() { - return BoxComment.this; - } - - @Override - protected void parseJSONMember(JsonObject.Member member) { - super.parseJSONMember(member); - - try { - String memberName = member.getName(); - JsonValue value = member.getValue(); - if (memberName.equals("is_reply_comment")) { - this.isReplyComment = value.asBoolean(); - - } else if (memberName.equals("message")) { - this.message = value.asString(); - - } else if (memberName.equals("tagged_message")) { - this.taggedMessage = value.asString(); - - } else if (memberName.equals("created_by")) { - JsonObject userJSON = value.asObject(); - if (this.createdBy == null) { - String userID = userJSON.get("id").asString(); - BoxUser user = new BoxUser(getAPI(), userID); - this.createdBy = user.new Info(userJSON); - } else { - this.createdBy.update(userJSON); - } - - } else if (memberName.equals("created_at")) { - this.createdAt = BoxDateFormat.parse(value.asString()); - - } else if (memberName.equals("item")) { - this.parseItem(value); - - } else if (memberName.equals("modified_by")) { - JsonObject userJSON = value.asObject(); - if (this.modifiedBy == null) { - String userID = userJSON.get("id").asString(); - BoxUser user = new BoxUser(getAPI(), userID); - this.modifiedBy = user.new Info(userJSON); - } else { - this.modifiedBy.update(userJSON); - } - } - } catch (ParseException e) { - assert false : "A ParseException indicates a bug in the SDK."; - } - } - - private void parseItem(JsonValue value) { - JsonObject itemJSON = value.asObject(); - String itemType = itemJSON.get("type").asString(); - if (itemType.equals("file")) { - this.updateItemAsFile(itemJSON); - } else if (itemType.equals("comment")) { - this.updateItemAsComment(itemJSON); - } - } - - private void updateItemAsFile(JsonObject itemJSON) { - String itemID = itemJSON.get("id").asString(); - if (this.item != null && this.item instanceof BoxFile.Info && this.item.getID().equals(itemID)) { - this.item.update(itemJSON); - } else { - BoxFile file = new BoxFile(getAPI(), itemID); - this.item = file.new Info(itemJSON); - } - } - - private void updateItemAsComment(JsonObject itemJSON) { - String itemType = itemJSON.get("type").asString(); - String itemID = itemJSON.get("id").asString(); - if (this.item != null && this.item instanceof BoxComment.Info && this.item.getID().equals(itemID)) { - this.item.update(itemJSON); - } else { - BoxComment comment = new BoxComment(getAPI(), itemID); - this.item = comment.new Info(itemJSON); - } - } - } -} diff --git a/src/main/java/com/box/sdk/BoxDateFormat.java b/src/main/java/com/box/sdk/BoxDateFormat.java deleted file mode 100644 index 5d3571c09..000000000 --- a/src/main/java/com/box/sdk/BoxDateFormat.java +++ /dev/null @@ -1,54 +0,0 @@ -package com.box.sdk; - -import java.text.DateFormat; -import java.text.ParseException; -import java.text.SimpleDateFormat; -import java.util.Date; - -/** - * Contains methods for parsing and formatting dates for use with the Box API. - */ -public final class BoxDateFormat { - private static final ThreadLocalUnless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxFile extends BoxItem { - /** - * An array of all possible file fields that can be requested when calling {@link #getInfo()}. - */ - public static final String[] ALL_FIELDS = {"type", "id", "sequence_id", "etag", "sha1", "name", "description", - "size", "path_collection", "created_at", "modified_at", "trashed_at", "purged_at", "content_created_at", - "content_modified_at", "created_by", "modified_by", "owned_by", "shared_link", "parent", "item_status", - "version_number", "comment_count", "permissions", "tags", "lock", "extension", "is_package"}; - - private static final URLTemplate FILE_URL_TEMPLATE = new URLTemplate("files/%s"); - private static final URLTemplate CONTENT_URL_TEMPLATE = new URLTemplate("files/%s/content"); - private static final URLTemplate VERSIONS_URL_TEMPLATE = new URLTemplate("files/%s/versions"); - private static final URLTemplate COPY_URL_TEMPLATE = new URLTemplate("files/%s/copy"); - private static final URLTemplate ADD_COMMENT_URL_TEMPLATE = new URLTemplate("comments"); - private static final URLTemplate GET_COMMENTS_URL_TEMPLATE = new URLTemplate("files/%s/comments"); - private static final URLTemplate METADATA_URL_TEMPLATE = new URLTemplate("files/%s/metadata/%s"); - private static final String DEFAULT_METADATA_TYPE = "properties"; - private static final int BUFFER_SIZE = 8192; - - /** - * Constructs a BoxFile for a file with a given ID. - * @param api the API connection to be used by the file. - * @param id the ID of the file. - */ - public BoxFile(BoxAPIConnection api, String id) { - super(api, id); - } - - @Override - public BoxSharedLink createSharedLink(BoxSharedLink.Access access, Date unshareDate, - BoxSharedLink.Permissions permissions) { - - BoxSharedLink sharedLink = new BoxSharedLink(access, unshareDate, permissions); - Info info = new Info(); - info.setSharedLink(sharedLink); - - this.updateInfo(info); - return info.getSharedLink(); - } - - /** - * Adds a comment to this file. The message can contain @mentions by using the string @[userid:username] anywhere - * within the message, where userid and username are the ID and username of the person being mentioned. - * @see the tagged_message field - * for including @mentions. - * @param message the comment's message. - * @return information about the newly added comment. - */ - public BoxComment.Info addComment(String message) { - JsonObject itemJSON = new JsonObject(); - itemJSON.add("type", "file"); - itemJSON.add("id", this.getID()); - - JsonObject requestJSON = new JsonObject(); - requestJSON.add("item", itemJSON); - if (BoxComment.messageContainsMention(message)) { - requestJSON.add("tagged_message", message); - } else { - requestJSON.add("message", message); - } - - URL url = ADD_COMMENT_URL_TEMPLATE.build(this.getAPI().getBaseURL()); - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "POST"); - request.setBody(requestJSON.toString()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject responseJSON = JsonObject.readFrom(response.getJSON()); - - BoxComment addedComment = new BoxComment(this.getAPI(), responseJSON.get("id").asString()); - return addedComment.new Info(responseJSON); - } - - /** - * Downloads the contents of this file to a given OutputStream. - * @param output the stream to where the file will be written. - */ - public void download(OutputStream output) { - this.download(output, null); - } - - /** - * Downloads the contents of this file to a given OutputStream while reporting the progress to a ProgressListener. - * @param output the stream to where the file will be written. - * @param listener a listener for monitoring the download's progress. - */ - public void download(OutputStream output, ProgressListener listener) { - URL url = CONTENT_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "GET"); - BoxAPIResponse response = request.send(); - InputStream input = response.getBody(listener); - - byte[] buffer = new byte[BUFFER_SIZE]; - try { - int n = input.read(buffer); - while (n != -1) { - output.write(buffer, 0, n); - n = input.read(buffer); - } - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - - response.disconnect(); - } - - /** - * Downloads a part of this file's contents, starting at specified byte offset. - * @param output the stream to where the file will be written. - * @param offset the byte offset at which to start the download. - */ - public void downloadRange(OutputStream output, long offset) { - this.downloadRange(output, offset, -1); - } - - /** - * Downloads a part of this file's contents, starting at rangeStart and stopping at rangeEnd. - * @param output the stream to where the file will be written. - * @param rangeStart the byte offset at which to start the download. - * @param rangeEnd the byte offset at which to stop the download. - */ - public void downloadRange(OutputStream output, long rangeStart, long rangeEnd) { - this.downloadRange(output, rangeStart, rangeEnd, null); - } - - /** - * Downloads a part of this file's contents, starting at rangeStart and stopping at rangeEnd, while reporting the - * progress to a ProgressListener. - * @param output the stream to where the file will be written. - * @param rangeStart the byte offset at which to start the download. - * @param rangeEnd the byte offset at which to stop the download. - * @param listener a listener for monitoring the download's progress. - */ - public void downloadRange(OutputStream output, long rangeStart, long rangeEnd, ProgressListener listener) { - URL url = CONTENT_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "GET"); - if (rangeEnd > 0) { - request.addHeader("Range", String.format("bytes=%s-%s", Long.toString(rangeStart), - Long.toString(rangeEnd))); - } else { - request.addHeader("Range", String.format("bytes=%s-", Long.toString(rangeStart))); - } - - BoxAPIResponse response = request.send(); - InputStream input = response.getBody(listener); - - byte[] buffer = new byte[BUFFER_SIZE]; - try { - int n = input.read(buffer); - while (n != -1) { - output.write(buffer, 0, n); - n = input.read(buffer); - } - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - - response.disconnect(); - } - - @Override - public BoxFile.Info copy(BoxFolder destination) { - return this.copy(destination, null); - } - - @Override - public BoxFile.Info copy(BoxFolder destination, String newName) { - URL url = COPY_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - - JsonObject parent = new JsonObject(); - parent.add("id", destination.getID()); - - JsonObject copyInfo = new JsonObject(); - copyInfo.add("parent", parent); - if (newName != null) { - copyInfo.add("name", newName); - } - - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "POST"); - request.setBody(copyInfo.toString()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject responseJSON = JsonObject.readFrom(response.getJSON()); - BoxFile copiedFile = new BoxFile(this.getAPI(), responseJSON.get("id").asString()); - return copiedFile.new Info(responseJSON); - } - - /** - * Deletes this file by moving it to the trash. - */ - public void delete() { - URL url = FILE_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "DELETE"); - BoxAPIResponse response = request.send(); - response.disconnect(); - } - - @Override - public BoxItem.Info move(BoxFolder destination) { - return this.move(destination, null); - } - - @Override - public BoxItem.Info move(BoxFolder destination, String newName) { - URL url = FILE_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT"); - - JsonObject parent = new JsonObject(); - parent.add("id", destination.getID()); - - JsonObject updateInfo = new JsonObject(); - updateInfo.add("parent", parent); - if (newName != null) { - updateInfo.add("name", newName); - } - - request.setBody(updateInfo.toString()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject responseJSON = JsonObject.readFrom(response.getJSON()); - BoxFile movedFile = new BoxFile(this.getAPI(), responseJSON.get("id").asString()); - return movedFile.new Info(responseJSON); - } - - /** - * Renames this file. - * @param newName the new name of the file. - */ - public void rename(String newName) { - URL url = FILE_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT"); - - JsonObject updateInfo = new JsonObject(); - updateInfo.add("name", newName); - - request.setBody(updateInfo.toString()); - BoxAPIResponse response = request.send(); - response.disconnect(); - } - - @Override - public BoxFile.Info getInfo() { - URL url = FILE_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "GET"); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - return new Info(response.getJSON()); - } - - @Override - public BoxFile.Info getInfo(String... fields) { - String queryString = new QueryStringBuilder().appendParam("fields", fields).toString(); - URL url = FILE_URL_TEMPLATE.buildWithQuery(this.getAPI().getBaseURL(), queryString, this.getID()); - - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "GET"); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - return new Info(response.getJSON()); - } - - /** - * Updates the information about this file with any info fields that have been modified locally. - * - *The only fields that will be updated are the ones that have been modified locally. For example, the following - * code won't update any information (or even send a network request) since none of the info's fields were - * changed:
- * - *BoxFile file = new File(api, id); - *BoxFile.Info info = file.getInfo(); - *file.updateInfo(info);- * - * @param info the updated info. - */ - public void updateInfo(BoxFile.Info info) { - URL url = FILE_URL_TEMPLATE.build(this.getAPI().getBaseURL(), this.getID()); - BoxJSONRequest request = new BoxJSONRequest(this.getAPI(), url, "PUT"); - request.setBody(info.getPendingChanges()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject jsonObject = JsonObject.readFrom(response.getJSON()); - info.update(jsonObject); - } - - /** - * Gets any previous versions of this file. Note that only users with premium accounts will be able to retrieve - * previous versions of their files. - * @return a list of previous file versions. - */ - public Collection
Unless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxFolder extends BoxItem implements IterableUnless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxGroup extends BoxCollaborator { - private static final URLTemplate GROUPS_URL_TEMPLATE = new URLTemplate("groups"); - private static final URLTemplate GROUP_URL_TEMPLATE = new URLTemplate("groups/%s"); - - /** - * Constructs a BoxGroup for a group with a given ID. - * @param api the API connection to be used by the group. - * @param id the ID of the group. - */ - public BoxGroup(BoxAPIConnection api, String id) { - super(api, id); - } - - /** - * Creates a new group with a specified name. - * @param api the API connection to be used by the group. - * @param name the name of the new group. - * @return info about the created group. - */ - public static BoxGroup.Info createGroup(BoxAPIConnection api, String name) { - JsonObject requestJSON = new JsonObject(); - requestJSON.add("name", name); - - URL url = GROUPS_URL_TEMPLATE.build(api.getBaseURL()); - BoxJSONRequest request = new BoxJSONRequest(api, url, "POST"); - request.setBody(requestJSON.toString()); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject responseJSON = JsonObject.readFrom(response.getJSON()); - - BoxGroup group = new BoxGroup(api, responseJSON.get("id").asString()); - return group.new Info(responseJSON); - } - - /** - * Gets an iterable of all the groups that the current user is a member of. - * @param api the API connection to be used when retrieving the groups. - * @return an iterable containing info about all the groups. - */ - public static IterableThis method is a convenience method for manually creating a new shared link and applying it to this item with - * {@link Info#setSharedLink}. You may want to create the shared link manually so that it can be updated along with - * other changes to the item's info in a single network request, giving a boost to performance.
- * - * @param access the access level of the shared link. - * @param unshareDate the date and time at which the link will expire. Can be null to create a non-expiring link. - * @param permissions the permissions of the shared link. Can be null to use the default permissions. - * @return the created shared link. - */ - public abstract BoxSharedLink createSharedLink(BoxSharedLink.Access access, Date unshareDate, - BoxSharedLink.Permissions permissions); - - /** - * Gets information about this item. - * @return info about this item. - */ - public abstract BoxItem.Info getInfo(); - - /** - * Gets information about this item that's limited to a list of specified fields. - * @param fields the fields to retrieve. - * @return info about this item containing only the specified fields. - */ - public abstract BoxItem.Info getInfo(String... fields); - - /** - * Contains information about a BoxItem. - */ - public abstract class Info extends BoxResource.Info { - private String sequenceID; - private String etag; - private String name; - private Date createdAt; - private Date modifiedAt; - private String description; - private long size; - private ListNote that this field isn't populated by default and must be specified as a field parameter when getting - * Info about the item.
- * - * @return a list of all the tags applied to the item. - */ - public ListSubclasses should override this method in order to parse any JSON members it knows about. This method is a - * no-op by default.
- * - * @param member the JSON member to be parsed. - */ - void parseJSONMember(JsonObject.Member member) { } - - /** - * Adds a pending field change that needs to be sent to the API. It will be included in the JSON string the next - * time {@link #getPendingChanges} is called. - * @param key the name of the field. - * @param value the new boolean value of the field. - */ - void addPendingChange(String key, boolean value) { - if (this.pendingChanges == null) { - this.pendingChanges = new JsonObject(); - } - - this.pendingChanges.set(key, value); - } - - /** - * Adds a pending field change that needs to be sent to the API. It will be included in the JSON string the next - * time {@link #getPendingChanges} is called. - * @param key the name of the field. - * @param value the new String value of the field. - */ - void addPendingChange(String key, String value) { - this.addPendingChange(key, JsonValue.valueOf(value)); - } - - void addChildObject(String fieldName, BoxJSONObject child) { - if (child == null) { - this.addPendingChange(fieldName, JsonValue.NULL); - } else { - this.children.put(fieldName, child); - } - } - - void removeChildObject(String fieldName) { - this.children.remove(fieldName); - } - - /** - * Adds a pending field change that needs to be sent to the API. It will be included in the JSON string the next - * time {@link #getPendingChanges} is called. - * @param key the name of the field. - * @param value the JsonValue of the field. - */ - private void addPendingChange(String key, JsonValue value) { - if (this.pendingChanges == null) { - this.pendingChanges = new JsonObject(); - } - - this.pendingChanges.set(key, value); - } - - void removePendingChange(String key) { - if (this.pendingChanges != null) { - this.pendingChanges.remove(key); - } - } - - /** - * Updates this BoxJSONObject using the information in a JSON object. - * @param jsonObject the JSON object containing updated information. - */ - void update(JsonObject jsonObject) { - for (JsonObject.Member member : jsonObject) { - if (member.getValue().isNull()) { - continue; - } - - this.parseJSONMember(member); - } - - this.clearPendingChanges(); - } - - /** - * Gets a JsonObject containing any pending changes to this object that can be sent back to the Box API. - * @return a JsonObject containing the pending changes. - */ - private JsonObject getPendingJSONObject() { - for (Map.EntryThis request type extends BoxAPIRequest to provide additional functionality for handling JSON strings. It - * automatically sets the appropriate "Content-Type" HTTP headers and allows the JSON in the request to be logged.
- */ -public class BoxJSONRequest extends BoxAPIRequest { - private String json; - - /** - * Constructs an authenticated BoxJSONRequest using a provided BoxAPIConnection. - * @param api an API connection for authenticating the request. - * @param url the URL of the request. - * @param method the HTTP method of the request. - */ - public BoxJSONRequest(BoxAPIConnection api, URL url, String method) { - super(api, url, method); - - this.addHeader("Content-Type", "application/json"); - } - - /** - * Sets the body of this request to a given JSON string. - * @param body the JSON string to use as the body. - */ - @Override - public void setBody(String body) { - super.setBody(body); - this.json = body; - } - - @Override - protected String bodyToString() { - return this.json; - } -} diff --git a/src/main/java/com/box/sdk/BoxJSONResponse.java b/src/main/java/com/box/sdk/BoxJSONResponse.java deleted file mode 100644 index eb7746f18..000000000 --- a/src/main/java/com/box/sdk/BoxJSONResponse.java +++ /dev/null @@ -1,65 +0,0 @@ -package com.box.sdk; - -import java.io.IOException; -import java.io.InputStreamReader; -import java.net.HttpURLConnection; - -/** - * Used to read HTTP responses containing JSON from the Box API. - * - *This request type extends BoxAPIResponse to provide additional functionality for handling JSON strings. It reads - * the response body into a string and allows the JSON in the response to be logged.
- */ -public class BoxJSONResponse extends BoxAPIResponse { - private static final int BUFFER_SIZE = 8192; - - private String json; - - /** - * Constructs a BoxJSONResponse using an HttpURLConnection. - * @param connection a connection that has already sent a request to the API. - */ - public BoxJSONResponse(HttpURLConnection connection) { - super(connection); - } - - /** - * Gets the body of the response as a JSON string. When this method is called, the response's body will be read and - * the response will be disconnected, meaning that the stream returned by {@link #getBody} can no longer be used. - * @return the body of the response as a JSON string. - */ - public String getJSON() { - if (this.json != null) { - return this.json; - } - - InputStreamReader reader = new InputStreamReader(this.getBody(), StandardCharsets.UTF_8); - StringBuilder builder = new StringBuilder(); - char[] buffer = new char[BUFFER_SIZE]; - - try { - int read = reader.read(buffer, 0, BUFFER_SIZE); - while (read != -1) { - builder.append(buffer, 0, read); - read = reader.read(buffer, 0, BUFFER_SIZE); - } - - this.disconnect(); - reader.close(); - } catch (IOException e) { - throw new BoxAPIException("Couldn't connect to the Box API due to a network error.", e); - } - this.json = builder.toString(); - return this.json; - } - - @Override - protected String bodyToString() { - String bodyString = super.bodyToString(); - if (bodyString == null) { - return this.getJSON(); - } else { - return bodyString; - } - } -} diff --git a/src/main/java/com/box/sdk/BoxMultipartRequest.java b/src/main/java/com/box/sdk/BoxMultipartRequest.java deleted file mode 100644 index c4fb01482..000000000 --- a/src/main/java/com/box/sdk/BoxMultipartRequest.java +++ /dev/null @@ -1,203 +0,0 @@ -package com.box.sdk; - -import java.io.IOException; -import java.io.InputStream; -import java.io.OutputStream; -import java.net.HttpURLConnection; -import java.net.URL; -import java.util.Date; -import java.util.HashMap; -import java.util.Map; -import java.util.logging.Level; -import java.util.logging.Logger; - -/** - * Used to make HTTP multipart requests to the Box API. - * - *This class partially implements the HTTP multipart standard in order to upload files to Box. The body of this - * request type cannot be set directly. Instead, it can be modified by adding multipart fields and setting file - * contents. The body of multipart requests will not be logged since they are likely to contain binary data.
- * - */ -public class BoxMultipartRequest extends BoxAPIRequest { - private static final Logger LOGGER = Logger.getLogger(BoxMultipartRequest.class.getName()); - private static final String BOUNDARY = "da39a3ee5e6b4b0d3255bfef95601890afd80709"; - private static final int BUFFER_SIZE = 8192; - - private final StringBuilder loggedRequest = new StringBuilder(); - - private OutputStream outputStream; - private InputStream inputStream; - private String filename; - private long fileSize; - private MapEvery API resource has an ID and a {@link BoxAPIConnection} that it uses to communicate with the API. Some - * resources also have an associated {@link Info} class that contains information about the resource.
- */ -public abstract class BoxResource { - private final BoxAPIConnection api; - private final String id; - - /** - * Constructs a BoxResource for a resource with a given ID. - * @param api the API connection to be used by the resource. - * @param id the ID of the resource. - */ - public BoxResource(BoxAPIConnection api, String id) { - this.api = api; - this.id = id; - } - - static BoxResource.Info parseInfo(BoxAPIConnection api, JsonObject jsonObject) { - String type = jsonObject.get("type").asString(); - String id = jsonObject.get("id").asString(); - - if (type.equals("folder")) { - BoxFolder folder = new BoxFolder(api, id); - return folder.new Info(jsonObject); - } else if (type.equals("file")) { - BoxFile file = new BoxFile(api, id); - return file.new Info(jsonObject); - } else if (type.equals("comment")) { - BoxComment comment = new BoxComment(api, id); - return comment.new Info(jsonObject); - } else if (type.equals("collaboration")) { - BoxCollaboration collaboration = new BoxCollaboration(api, id); - return collaboration.new Info(jsonObject); - } else if (type.equals("user")) { - BoxUser user = new BoxUser(api, id); - return user.new Info(jsonObject); - } else if (type.equals("group")) { - BoxGroup group = new BoxGroup(api, id); - return group.new Info(jsonObject); - } else { - return null; - } - } - - /** - * Gets the API connection used by this resource. - * @return the API connection used by this resource. - */ - public BoxAPIConnection getAPI() { - return this.api; - } - - /** - * Gets the ID of this resource. - * @return the ID of this resource. - */ - public String getID() { - return this.id; - } - - /** - * Indicates whether this BoxResource is equal to another BoxResource. Two BoxResources are equal if they have the - * same type and ID. - * @param other the other BoxResource to compare. - * @return true if the type and IDs of the two resources are equal; otherwise false. - */ - @Override - public boolean equals(Object other) { - if (other == null) { - return false; - } - - if (this.getClass().equals(other.getClass())) { - BoxResource otherResource = (BoxResource) other; - return this.getID().equals(otherResource.getID()); - } - - return false; - } - - /** - * Returns a hash code value for this BoxResource. - * @return a hash code value for this BoxResource. - */ - @Override - public int hashCode() { - return this.getID().hashCode(); - } - - /** - * Contains information about a BoxResource. - */ - public abstract class Info extends BoxJSONObject { - /** - * Constructs an empty Info object. - */ - public Info() { - super(); - } - - /** - * Constructs an Info object by parsing information from a JSON string. - * @param json the JSON string to parse. - */ - public Info(String json) { - super(json); - } - - /** - * Constructs an Info object using an already parsed JSON object. - * @param jsonObject the parsed JSON object. - */ - Info(JsonObject jsonObject) { - super(jsonObject); - } - - /** - * Gets the ID of the resource associated with this Info. - * @return the ID of the associated resource. - */ - public String getID() { - return BoxResource.this.getID(); - } - - /** - * Gets the resource associated with this Info. - * @return the associated resource. - */ - public abstract BoxResource getResource(); - } -} diff --git a/src/main/java/com/box/sdk/BoxSharedLink.java b/src/main/java/com/box/sdk/BoxSharedLink.java deleted file mode 100644 index c031eca53..000000000 --- a/src/main/java/com/box/sdk/BoxSharedLink.java +++ /dev/null @@ -1,291 +0,0 @@ -package com.box.sdk; - -import java.text.ParseException; -import java.util.Date; - -import com.eclipsesource.json.JsonObject; -import com.eclipsesource.json.JsonValue; - -/** - * Represents a link to a file or folder on Box. - */ -public class BoxSharedLink extends BoxJSONObject { - private String url; - private String downloadUrl; - private String vanityUrl; - private boolean isPasswordEnabled; - private Date unsharedAt; - private long downloadCount; - private long previewCount; - private Access access; - private Permissions permissions; - - /** - * Constructs a BoxSharedLink with default settings. - */ - public BoxSharedLink() { } - - /** - * Constructs a BoxSharedLink from a JSON string. - * @param json the JSON encoded shared link. - */ - public BoxSharedLink(String json) { - super(json); - } - - BoxSharedLink(JsonObject jsonObject) { - super(jsonObject); - } - - BoxSharedLink(BoxSharedLink.Access access, Date unshareDate, BoxSharedLink.Permissions permissions) { - this.setAccess(access); - this.setPermissions(permissions); - - if (unshareDate != null) { - this.setUnsharedDate(unshareDate); - } - } - - /** - * Get the URL of this shared link. - * @return the URL of this shared link. - */ - public String getURL() { - return this.url; - } - - /** - * Gets the direct download URL of this shared link. - * @return the direct download URL of this shared link. - */ - public String getDownloadURL() { - return this.downloadUrl; - } - - /** - * Gets the vanity URL of this shared link. - * @return the vanity URL of this shared link. - */ - public String getVanityURL() { - return this.vanityUrl; - } - - /** - * Gets whether or not a password is enabled on this shared link. - * @return true if there's a password enabled on this shared link; otherwise false. - */ - public boolean getIsPasswordEnabled() { - return this.isPasswordEnabled; - } - - /** - * Gets the time that this shared link will be deactivated. - * @return the time that this shared link will be deactivated. - */ - public Date getUnsharedDate() { - return this.unsharedAt; - } - - /** - * Sets the time that this shared link will be deactivated. - * @param unsharedDate the time that this shared link will be deactivated. - */ - public void setUnsharedDate(Date unsharedDate) { - this.unsharedAt = unsharedDate; - this.addPendingChange("unshared_at", unsharedDate.toString()); - } - - /** - * Gets the number of times that this shared link has been downloaded. - * @return the number of times that this link has been downloaded. - */ - public long getDownloadCount() { - return this.downloadCount; - } - - /** - * Gets the number of times that this shared link has been previewed. - * @return the number of times that this link has been previewed. - */ - public long getPreviewCount() { - return this.previewCount; - } - - /** - * Gets the access level of this shared link. - * @return the access level of this shared link. - */ - public Access getAccess() { - return this.access; - } - - /** - * Sets the access level of this shared link. - * @param access the new acccess level of this shared link. - */ - public void setAccess(Access access) { - this.access = access; - this.addPendingChange("access", access.toJSONValue()); - } - - /** - * Gets the permissions associated with this shared link. - * @return the permissions associated with this shared link. - */ - public Permissions getPermissions() { - return this.permissions; - } - - /** - * Sets the permissions associated with this shared link. - * @param permissions the new permissions for this shared link. - */ - public void setPermissions(Permissions permissions) { - if (this.permissions == permissions) { - return; - } - - this.removeChildObject("permissions"); - this.permissions = permissions; - this.addChildObject("permissions", permissions); - } - - @Override - void parseJSONMember(JsonObject.Member member) { - JsonValue value = member.getValue(); - try { - String memberName = member.getName(); - if (memberName.equals("url")) { - this.url = value.asString(); - } else if (memberName.equals("download_url")) { - this.downloadUrl = value.asString(); - } else if (memberName.equals("vanity_url")) { - this.vanityUrl = value.asString(); - } else if (memberName.equals("is_password_enabled")) { - this.isPasswordEnabled = value.asBoolean(); - } else if (memberName.equals("unshared_at")) { - this.unsharedAt = BoxDateFormat.parse(value.asString()); - } else if (memberName.equals("download_count")) { - this.downloadCount = Double.valueOf(value.toString()).longValue(); - } else if (memberName.equals("preview_count")) { - this.previewCount = Double.valueOf(value.toString()).longValue(); - } else if (memberName.equals("access")) { - String accessString = value.asString().toUpperCase(); - this.access = Access.valueOf(accessString); - } else if (memberName.equals("permissions")) { - if (this.permissions == null) { - this.setPermissions(new Permissions(value.asObject())); - } else { - this.permissions.update(value.asObject()); - } - } - } catch (ParseException e) { - assert false : "A ParseException indicates a bug in the SDK."; - } - } - - /** - * Contains permissions fields that can be set on a shared link. - */ - public static class Permissions extends BoxJSONObject { - private boolean canDownload; - private boolean canPreview; - - /** - * Constructs a Permissions object with all permissions disabled. - */ - public Permissions() { } - - /** - * Constructs a Permissions object from a JSON string. - * @param json the JSON encoded shared link permissions. - */ - public Permissions(String json) { - super(json); - } - - Permissions(JsonObject jsonObject) { - super(jsonObject); - } - - /** - * Gets whether or not the shared link can be downloaded. - * @return true if the shared link can be downloaded; otherwise false. - */ - public boolean getCanDownload() { - return this.canDownload; - } - - /** - * Sets whether or not the shared link can be downloaded. - * @param enabled true if the shared link can be downloaded; otherwise false. - */ - public void setCanDownload(boolean enabled) { - this.canDownload = enabled; - this.addPendingChange("can_download", enabled); - } - - /** - * Gets whether or not the shared link can be previewed. - * @return true if the shared link can be previewed; otherwise false. - */ - public boolean getCanPreview() { - return this.canPreview; - } - - /** - * Sets whether or not the shared link can be previewed. - * @param enabled true if the shared link can be previewed; otherwise false. - */ - public void setCanPreview(boolean enabled) { - this.canPreview = enabled; - this.addPendingChange("can_preview", enabled); - } - - @Override - void parseJSONMember(JsonObject.Member member) { - JsonValue value = member.getValue(); - String memberName = member.getName(); - if (memberName.equals("can_download")) { - this.canDownload = value.asBoolean(); - } else if (memberName.equals("can_preview")) { - this.canPreview = value.asBoolean(); - } - } - } - - /** - * Enumerates the possible access levels that can be set on a shared link. - */ - public enum Access { - /** - * The default access level for the user or enterprise. - */ - DEFAULT (null), - - /** - * The link can be accessed by anyone. - */ - OPEN ("open"), - - /** - * The link can be accessed by other users within the company. - */ - COMPANY ("company"), - - /** - * The link can be accessed by other collaborators. - */ - COLLABORATORS ("collaborators"); - - private final String jsonValue; - - private Access(String jsonValue) { - this.jsonValue = jsonValue; - } - - String toJSONValue() { - return this.jsonValue; - } - } -} diff --git a/src/main/java/com/box/sdk/BoxTrash.java b/src/main/java/com/box/sdk/BoxTrash.java deleted file mode 100644 index a7814c898..000000000 --- a/src/main/java/com/box/sdk/BoxTrash.java +++ /dev/null @@ -1,219 +0,0 @@ -package com.box.sdk; - -import java.net.URL; -import java.util.Iterator; - -import com.eclipsesource.json.JsonObject; - -/** - * Provides methods for deleting, recovering, and viewing a user's trashed files and folders. - * - *Unless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxTrash implements IterableUnless otherwise noted, the methods in this class can throw an unchecked {@link BoxAPIException} (unchecked - * meaning that the compiler won't force you to handle it) if an error occurs. If you wish to implement custom error - * handling for errors related to the Box REST API, you should capture this exception explicitly.
- */ -public class BoxUser extends BoxCollaborator { - private static final URLTemplate GET_USER_URL = new URLTemplate("users/%s"); - private static final URLTemplate GET_ME_URL = new URLTemplate("users/me"); - - /** - * Constructs a BoxUser for a user with a given ID. - * @param api the API connection to be used by the user. - * @param id the ID of the user. - */ - public BoxUser(BoxAPIConnection api, String id) { - super(api, id); - } - - /** - * Gets the current user. - * @param api the API connection of the current user. - * @return the current user. - */ - public static BoxUser getCurrentUser(BoxAPIConnection api) { - URL url = GET_ME_URL.build(api.getBaseURL()); - BoxAPIRequest request = new BoxAPIRequest(api, url, "GET"); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject jsonObject = JsonObject.readFrom(response.getJSON()); - return new BoxUser(api, jsonObject.get("id").asString()); - } - - /** - * Gets information about this user. - * @return info about this user. - */ - public BoxUser.Info getInfo() { - URL url = GET_USER_URL.build(this.getAPI().getBaseURL(), this.getID()); - BoxAPIRequest request = new BoxAPIRequest(this.getAPI(), url, "GET"); - BoxJSONResponse response = (BoxJSONResponse) request.send(); - JsonObject jsonObject = JsonObject.readFrom(response.getJSON()); - return new Info(jsonObject); - } - - /** - * Enumerates the possible roles that a user can have within an enterprise. - */ - public enum Role { - /** - * The user is an administrator of their enterprise. - */ - ADMIN, - - /** - * The user is a co-administrator of their enterprise. - */ - COADMIN, - - /** - * The user is a regular user within their enterprise. - */ - USER - } - - /** - * Enumerates the possible statuses that a user's account can have. - */ - public enum Status { - /** - * The user's account is active. - */ - ACTIVE, - - /** - * The user's account is inactive. - */ - INACTIVE, - - /** - * The user's account cannot delete or edit content. - */ - CANNOT_DELETE_EDIT, - - /** - * The user's account cannot delete, edit, or upload content. - */ - CANNOT_DELETE_EDIT_UPLOAD - } - - /** - * Contains information about a BoxUser. - */ - public class Info extends BoxCollaborator.Info { - private String login; - private Role role; - private String language; - private String timezone; - private long spaceAmount; - private long spaceUsed; - private long maxUploadSize; - private Status status; - private String jobTitle; - private String phone; - private String address; - private String avatarURL; - - Info(JsonObject jsonObject) { - super(jsonObject); - } - - @Override - public BoxUser getResource() { - return BoxUser.this; - } - - /** - * Gets the email address the user uses to login. - * @return the email address the user uses to login. - */ - public String getLogin() { - return this.login; - } - - /** - * Gets the user's enterprise role. - * @return the user's enterprise role. - */ - public Role getRole() { - return this.role; - } - - /** - * Gets the language of the user. - * @return the language of the user. - */ - public String getLanguage() { - return this.language; - } - - /** - * Gets the timezone of the user. - * @return the timezone of the user. - */ - public String getTimezone() { - return this.timezone; - } - - /** - * Gets the user's total available space in bytes. - * @return the user's total available space in bytes. - */ - public long getSpaceAmount() { - return this.spaceAmount; - } - - /** - * Gets the amount of space the user has used in bytes. - * @return the amount of space the user has used in bytes. - */ - public long getSpaceUsed() { - return this.spaceUsed; - } - - /** - * Gets the maximum individual file size in bytes the user can have. - * @return the maximum individual file size in bytes the user can have. - */ - public long getMaxUploadSize() { - return this.maxUploadSize; - } - - /** - * Gets the user's current account status. - * @return the user's current account status. - */ - public Status getStatus() { - return this.status; - } - - /** - * Gets the job title of the user. - * @return the job title of the user. - */ - public String getJobTitle() { - return this.jobTitle; - } - - /** - * Gets the phone number of the user. - * @return the phone number of the user. - */ - public String getPhone() { - return this.phone; - } - - /** - * Gets the address of the user. - * @return the address of the user. - */ - public String getAddress() { - return this.address; - } - - /** - * Gets the URL of the user's avatar. - * @return the URL of the user's avatar. - */ - public String getAvatarURL() { - return this.avatarURL; - } - - @Override - protected void parseJSONMember(JsonObject.Member member) { - super.parseJSONMember(member); - - JsonValue value = member.getValue(); - String memberName = member.getName(); - if (memberName.equals("login")) { - this.login = value.asString(); - } else if (memberName.equals("role")) { - this.role = this.parseRole(value); - } else if (memberName.equals("language")) { - this.language = value.asString(); - } else if (memberName.equals("timezone")) { - this.timezone = value.asString(); - } else if (memberName.equals("space_amount")) { - this.spaceAmount = Double.valueOf(value.toString()).longValue(); - } else if (memberName.equals("space_used")) { - this.spaceUsed = Double.valueOf(value.toString()).longValue(); - } else if (memberName.equals("max_upload_size")) { - this.maxUploadSize = Double.valueOf(value.toString()).longValue(); - } else if (memberName.equals("status")) { - this.status = this.parseStatus(value); - } else if (memberName.equals("job_title")) { - this.jobTitle = value.asString(); - } else if (memberName.equals("phone")) { - this.phone = value.asString(); - } else if (memberName.equals("address")) { - this.address = value.asString(); - } else if (memberName.equals("avatar_url")) { - this.avatarURL = value.asString(); - } - } - - private Role parseRole(JsonValue value) { - String roleString = value.asString().toUpperCase(); - return Role.valueOf(roleString); - } - - private Status parseStatus(JsonValue value) { - String statusString = value.asString().toUpperCase(); - return Status.valueOf(statusString); - } - } -} diff --git a/src/main/java/com/box/sdk/EventListener.java b/src/main/java/com/box/sdk/EventListener.java deleted file mode 100644 index daef86501..000000000 --- a/src/main/java/com/box/sdk/EventListener.java +++ /dev/null @@ -1,29 +0,0 @@ -package com.box.sdk; - -/** - * The listener interface for receiving events from an {@link EventStream}. - */ -public interface EventListener { - /** - * Invoked when an event is received from the API. - * @param event the received event. - */ - void onEvent(BoxEvent event); - - /** - * Invoked when an updated stream position is received from the API. - * @param position of the stream. - */ - void onNextPosition(long position); - - /** - * Invoked when an error occurs while waiting for events to be received. - * - *When an EventStream encounters an exception, it will invoke this method on each of its listeners until one - * of them returns true, indicating that the exception was handled.
- * - * @param e the exception that was thrown while waiting for events. - * @return true if the exception was handled; otherwise false. - */ - boolean onException(Throwable e); -} diff --git a/src/main/java/com/box/sdk/EventStream.java b/src/main/java/com/box/sdk/EventStream.java deleted file mode 100644 index f523aa732..000000000 --- a/src/main/java/com/box/sdk/EventStream.java +++ /dev/null @@ -1,206 +0,0 @@ -package com.box.sdk; - -import java.util.ArrayList; -import java.util.Collection; - -import com.eclipsesource.json.JsonArray; -import com.eclipsesource.json.JsonObject; -import com.eclipsesource.json.JsonValue; - -/** - * Receives real-time events from the API and forwards them to {@link EventListener EventListeners}. - * - *This class handles long polling the Box events endpoint in order to receive real-time user or enterprise events. - * When an EventStream is started, it begins long polling on a separate thread until the {@link #stop} method is called. - * Since the API may return duplicate events, EventStream also maintains a small cache of the most recently received - * event IDs in order to automatically deduplicate events.
- * - */ -public class EventStream { - private static final int LIMIT = 800; - private static final URLTemplate EVENT_URL = new URLTemplate("events?limit=" + LIMIT + "&stream_position=%s"); - private static final int STREAM_POSITION_NOW = -1; - - private final BoxAPIConnection api; - private final long startingPosition; - private final CollectionThis method can be overridden by a subclass in order to provide custom de-duping logic.
- * - * @param eventID the event ID. - * @return true if the event is a duplicate; otherwise false. - */ - protected boolean isDuplicate(String eventID) { - if (this.receivedEvents == null) { - this.receivedEvents = new LRUCacheAn interceptor may handle a request in any way it sees fit. It may update a request before it's sent, or it may - * choose to return a custom response. If an interceptor returns a null response, then the request will continue to be - * sent to the API along with any changes that the interceptor may have made to it.
- * - *public BoxAPIResponse onRequest(BoxAPIRequest request) {
- * request.addHeader("My-Header", "My-Value");
- *
- * // Returning null means the request will be sent along with our new header.
- * return null;
- *}
- *
- * However, if a response is returned, then the request won't be sent and the interceptor's response will take the - * place of the normal response.
- * - *public BoxAPIResponse onRequest(BoxAPIRequest request) {
- * // Returning our own response means the request won't be sent at all.
- * return new BoxAPIResponse();
- *}
- *
- * A RequestInterceptor can be very useful for testing purposes. Requests to the Box API can be intercepted and fake - * responses can be returned, allowing you to effectively test your code without needing to actually communicate with - * the Box API.
- */ -public interface RequestInterceptor { - /** - * Invoked when a request is about to be sent to the API. - * @param request the request that is about to be sent. - * @return an optional response to the request. If the response is null, then the request will continue to - * be sent to the Box API. - */ - BoxAPIResponse onRequest(BoxAPIRequest request); -} diff --git a/src/main/java/com/box/sdk/SharedLinkAPIConnection.java b/src/main/java/com/box/sdk/SharedLinkAPIConnection.java deleted file mode 100644 index 0d5c0a693..000000000 --- a/src/main/java/com/box/sdk/SharedLinkAPIConnection.java +++ /dev/null @@ -1,134 +0,0 @@ -package com.box.sdk; - -/** - * This API connection uses a shared link (along with an optional password) to authenticate with the Box API. It wraps a - * preexisting BoxAPIConnection in order to provide additional access to items that are accessible with a shared link. - */ -class SharedLinkAPIConnection extends BoxAPIConnection { - private final BoxAPIConnection wrappedConnection; - private final String sharedLink; - private final String sharedLinkPassword; - - SharedLinkAPIConnection(BoxAPIConnection connection, String sharedLink) { - this(connection, sharedLink, null); - } - - SharedLinkAPIConnection(BoxAPIConnection connection, String sharedLink, String sharedLinkPassword) { - super(null); - - this.wrappedConnection = connection; - this.sharedLink = sharedLink; - this.sharedLinkPassword = sharedLinkPassword; - } - - @Override - public long getExpires() { - return this.wrappedConnection.getExpires(); - } - - @Override - public void setExpires(long milliseconds) { - this.wrappedConnection.setExpires(milliseconds); - } - - @Override - public String getBaseURL() { - return this.wrappedConnection.getBaseURL(); - } - - @Override - public void setBaseURL(String baseURL) { - this.wrappedConnection.setBaseURL(baseURL); - } - - @Override - public String getBaseUploadURL() { - return this.wrappedConnection.getBaseUploadURL(); - } - - @Override - public void setBaseUploadURL(String baseUploadURL) { - this.wrappedConnection.setBaseUploadURL(baseUploadURL); - } - - @Override - public String getUserAgent() { - return this.wrappedConnection.getUserAgent(); - } - - @Override - public void setUserAgent(String userAgent) { - this.wrappedConnection.setUserAgent(userAgent); - } - - @Override - public String getAccessToken() { - return this.wrappedConnection.getAccessToken(); - } - - @Override - public void setAccessToken(String accessToken) { - this.wrappedConnection.setAccessToken(accessToken); - } - - @Override - public String getRefreshToken() { - return this.wrappedConnection.getRefreshToken(); - } - - @Override - public void setRefreshToken(String refreshToken) { - this.wrappedConnection.setRefreshToken(refreshToken); - } - - @Override - public void setAutoRefresh(boolean autoRefresh) { - this.wrappedConnection.setAutoRefresh(autoRefresh); - } - - @Override - public boolean getAutoRefresh() { - return this.wrappedConnection.getAutoRefresh(); - } - - @Override - public int getMaxRequestAttempts() { - return this.wrappedConnection.getMaxRequestAttempts(); - } - - @Override - public void setMaxRequestAttempts(int attempts) { - this.wrappedConnection.setMaxRequestAttempts(attempts); - } - - @Override - public boolean canRefresh() { - return this.wrappedConnection.canRefresh(); - } - - @Override - public boolean needsRefresh() { - return this.wrappedConnection.needsRefresh(); - } - - @Override - public void refresh() { - this.wrappedConnection.refresh(); - } - - /** - * Gets the shared link used for accessing shared items. - * @return the shared link used for accessing shared items. - */ - String getSharedLink() { - return this.sharedLink; - } - - /** - * Gets the shared link password used for accessing shared items. - * @return the shared link password used for accessing shared items. - */ - String getSharedLinkPassword() { - return this.sharedLinkPassword; - } -} diff --git a/src/main/java/com/box/sdk/StandardCharsets.java b/src/main/java/com/box/sdk/StandardCharsets.java deleted file mode 100644 index 8b77db633..000000000 --- a/src/main/java/com/box/sdk/StandardCharsets.java +++ /dev/null @@ -1,20 +0,0 @@ -package com.box.sdk; - -import java.nio.charset.Charset; - -/** - * Constant definitions for the standard Charsets. - * - * NB: Replace with java.nio.charset.StandardCharsets when we drop 1.6 support. - */ -public final class StandardCharsets { - - /** - * Eight-bit UCS Transformation Format. - */ - public static final Charset UTF_8 = Charset.forName("UTF-8"); - - private StandardCharsets() { - throw new UnsupportedOperationException(); - } -} diff --git a/src/main/java/com/box/sdk/Time.java b/src/main/java/com/box/sdk/Time.java deleted file mode 100644 index bc5881b2f..000000000 --- a/src/main/java/com/box/sdk/Time.java +++ /dev/null @@ -1,18 +0,0 @@ -package com.box.sdk; - -class Time { - private static final ThreadLocal