BoxAPIConnection (Box Java SDK)

Object
- BoxAPIConnection

Direct Known Subclasses:

BoxCCGAPIConnection, BoxDeveloperEditionAPIConnection, BoxTransactionalAPIConnection, SharedLinkAPIConnection
```
public class BoxAPIConnection
extends Object
```
Represents an authenticated connection to the Box API.
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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class BoxAPIConnection.ResourceLinkType
Used to categorize the types of resource links.

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`BoxAPIConnection.ResourceLinkType` Used to categorize the types of resource links.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`DEFAULT_BASE_AUTHORIZATION_URL` Default authorization URL
`static HostnameVerifier`	`DEFAULT_HOSTNAME_VERIFIER` Used as a marker to setup connection to use default HostnameVerifier Example:
`static int`	`DEFAULT_MAX_RETRIES` The default maximum number of times an API request will be retried after an error response is received.
`static X509TrustManager`	`DEFAULT_TRUST_MANAGER` Used as a marker to setup connection to use default HostnameVerifier Example:

Constructor Summary

Constructors
Constructor and Description
`BoxAPIConnection(BoxConfig boxConfig)` Constructs a new BoxAPIConnection levaraging BoxConfig.
`BoxAPIConnection(String accessToken)` Constructs a new BoxAPIConnection that authenticates with a developer or access token.
`BoxAPIConnection(String clientID, String clientSecret)` Constructs a new BoxAPIConnection.
`BoxAPIConnection(String clientID, String clientSecret, String authCode)` Constructs a new BoxAPIConnection with an auth code that was obtained from the first half of OAuth.
`BoxAPIConnection(String clientID, String clientSecret, String accessToken, String refreshToken)` Constructs a new BoxAPIConnection with an access token that can be refreshed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addListener(BoxAPIConnectionListener listener)` Add a listener to listen to Box API connection events.
`void`	`asSelf()` Sets this API connection to make API calls on behalf of the user with whom the access token is associated.
`void`	`asUser(String userID)` Set this API connection to make API calls on behalf of another users, impersonating them.
`void`	`authenticate(String authCode)` Authenticates the API connection by obtaining access and refresh tokens using the auth code that was obtained from the first half of OAuth.
`boolean`	`canRefresh()` Determines if this connection's access token can be refreshed.
`void`	`configureSslCertificatesValidation(X509TrustManager trustManager, HostnameVerifier hostnameVerifier)` Used to override default SSL certification handling.
`protected BoxAPIRequest`	`createTokenRequest(URL url)`
`protected BoxAPIConnection.ResourceLinkType`	`determineResourceLinkType(String resourceLink)` Determines the type of resource, given a link to a Box resource.
`void`	`enableNotifications()` Re-enable email notifications from API actions if they have been suppressed.
`protected void`	`extractTokens(JsonObject jsonObject)`
`String`	`getAccessToken()` Gets an access token that can be used to authenticate an API request.
`static URL`	`getAuthorizationURL(String clientID, URI redirectUri, String state, List<String> scopes)` Returns the default authorization URL which is used to perform the authorization_code based OAuth2 flow.
`URL`	`getAuthorizationURL(URI redirectUri, String state, List<String> scopes)` Returns the authorization URL which is used to perform the authorization_code based OAuth2 flow.
`boolean`	`getAutoRefresh()` Gets whether or not automatic refreshing of this connection's access token is enabled.
`String`	`getBaseAppUrl()` Gets the base App url.
`String`	`getBaseUploadURL()` Gets the base upload URL that's used when performing file uploads to Box.
`String`	`getBaseURL()` Gets the base URL that's used when sending requests to the Box API.
`String`	`getClientID()` Gets the client ID.
`String`	`getClientSecret()` Gets the client secret.
`int`	`getConnectTimeout()` Gets the connect timeout for this connection in milliseconds.
`long`	`getExpires()` Gets the amount of time for which this connection's access token is valid.
`protected HostnameVerifier`	`getHostnameVerifier()`
`protected String`	`getKeyValueOrDefault(JsonObject json, String key, String defaultValue)`
`long`	`getLastRefresh()` Gets the last time that the access token was refreshed.
`ScopedToken`	`getLowerScopedToken(List<String> scopes, String resource)` Get a lower-scoped token restricted to a resource for the list of scopes that are passed.
`int`	`getMaxRetryAttempts()` Gets the maximum number of times an API request will be retried after an error response is received.
`Proxy`	`getProxy()` Gets the proxy value to use for API calls to Box.
`String`	`getProxyPassword()` Gets the password to use for a proxy that requires basic auth.
`String`	`getProxyUsername()` Gets the username to use for a proxy that requires basic auth.
`int`	`getReadTimeout()` Gets the read timeout for this connection in milliseconds.
`protected ReadWriteLock`	`getRefreshLock()` Gets the refresh lock to be used when refreshing an access token.
`String`	`getRefreshToken()` Gets a refresh token that can be used to refresh an access token.
`RequestInterceptor`	`getRequestInterceptor()` Gets the RequestInterceptor associated with this API connection.
`String`	`getRevokeURL()` Returns the URL used for token revocation.
`String`	`getTokenURL()` Gets the token URL that's used to request access tokens.
`protected X509TrustManager`	`getTrustManager()`
`String`	`getUserAgent()` Gets the user agent that's used when sending requests to the Box API.
`protected OkHttpClient.Builder`	`modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder)` Can be used to modify OkHttp.Builder used to create connection.
`boolean`	`needsRefresh()` Determines if this connection's access token has expired and needs to be refreshed.
`protected void`	`notifyError(BoxAPIException error)` Notifies an error event to all the listeners.
`protected void`	`notifyRefresh()` Notifies a refresh event to all the listeners.
`void`	`refresh()` Refresh's this connection's access token using its refresh token.
`void`	`removeCustomHeader(String header)` Removes a custom header, so it will no longer be sent on requests through this API connection.
`void`	`removeListener(BoxAPIConnectionListener listener)` Remove a listener listening to Box API connection events.
`void`	`restore(String state)` Restores a saved connection state into this BoxAPIConnection.
`static BoxAPIConnection`	`restore(String clientID, String clientSecret, String state)` Restores a BoxAPIConnection from a saved state.
`void`	`revokeToken()` Revokes the tokens associated with this API connection.
`String`	`save()` Saves the state of this connection to a string so that it can be persisted and restored at a later time.
`void`	`setAccessToken(String accessToken)` Sets the access token to use when authenticating API requests.
`void`	`setAutoRefresh(boolean autoRefresh)` Enables or disables automatic refreshing of this connection's access token.
`void`	`setBaseAppUrl(String baseAppURL)` Sets the base App url.
`void`	`setBaseAuthorizationURL(String baseAuthorizationURL)` Sets authorization base URL which is used to perform the authorization_code based OAuth2 flow.
`void`	`setBaseUploadURL(String baseUploadURL)` Sets the base upload URL to be used when performing file uploads to Box.
`void`	`setBaseURL(String baseURL)` Sets the base URL to be used when sending requests to the Box API.
`void`	`setConnectTimeout(int connectTimeout)` Sets the connect timeout for this connection.
`void`	`setCustomHeader(String header, String value)` Sets a custom header to be sent on all requests through this API connection.
`void`	`setExpires(long milliseconds)` Sets the amount of time for which this connection's access token is valid before it must be refreshed.
`void`	`setLastRefresh(long lastRefresh)` Sets the last time that the access token was refreshed.
`void`	`setMaxRetryAttempts(int attempts)` Sets the maximum number of times an API request will be retried after an error response is received.
`void`	`setProxy(Proxy proxy)` Sets the proxy to use for API calls to Box.
`void`	`setProxyAuthenticator(Authenticator authenticator)` Sets a proxy authenticator that will be used when proxy requires authentication.
`void`	`setProxyBasicAuthentication(String proxyUsername, String proxyPassword)` Sets the proxy user and password used in basic authentication
`void`	`setProxyPassword(String proxyPassword)` Deprecated. Use `setProxyBasicAuthentication(String, String)`
`void`	`setProxyUsername(String proxyUsername)` Deprecated. Use `setProxyBasicAuthentication(String, String)`
`void`	`setReadTimeout(int readTimeout)` Sets the read timeout for this connection.
`void`	`setRefreshToken(String refreshToken)` Sets the refresh token to use when refreshing an access token.
`void`	`setRequestInterceptor(RequestInterceptor interceptor)` Sets a RequestInterceptor that can intercept requests and manipulate them before they're sent to the Box API.
`void`	`setUserAgent(String userAgent)` Sets the user agent to be used when sending requests to the Box API.
`void`	`suppressNotifications()` Suppresses email notifications from API actions.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_TRUST_MANAGER
```
public static final X509TrustManager DEFAULT_TRUST_MANAGER
```
    Used as a marker to setup connection to use default HostnameVerifier Example:
```
 BoxApiConnection api = new BoxApiConnection(...);
 HostnameVerifier myHostnameVerifier = ...
 api.configureSslCertificatesValidation(DEFAULT_TRUST_MANAGER, myHostnameVerifier);
 
```
  - DEFAULT_HOSTNAME_VERIFIER
```
public static final HostnameVerifier DEFAULT_HOSTNAME_VERIFIER
```
    Used as a marker to setup connection to use default HostnameVerifier Example:
```
 BoxApiConnection api = new BoxApiConnection(...);
 X509TrustManager myTrustManager = ...
 api.configureSslCertificatesValidation(myTrustManager, DEFAULT_HOSTNAME_VERIFIER);
 
```
  - DEFAULT_MAX_RETRIES
```
public static final int DEFAULT_MAX_RETRIES
```
    The default maximum number of times an API request will be retried after an error response is received.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BASE_AUTHORIZATION_URL
```
protected static final String DEFAULT_BASE_AUTHORIZATION_URL
```
    Default authorization URL
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BoxAPIConnection
```
public BoxAPIConnection(String accessToken)
```
    Constructs a new BoxAPIConnection that authenticates with a developer or access token.
    
    Parameters:
    
    accessToken - a developer or access token to use for authenticating with the API.
  - BoxAPIConnection
```
public BoxAPIConnection(String clientID,
                        String clientSecret,
                        String accessToken,
                        String refreshToken)
```
    Constructs a new BoxAPIConnection with an access token that can be refreshed.
    
    Parameters:
    
    clientID - the client ID to use when refreshing the access token.
    
    clientSecret - the client secret to use when refreshing the access token.
    
    accessToken - an initial access token to use for authenticating with the API.
    
    refreshToken - an initial refresh token to use when refreshing the access token.
  - BoxAPIConnection
```
public BoxAPIConnection(String clientID,
                        String clientSecret,
                        String authCode)
```
    Constructs a new BoxAPIConnection with an auth code that was obtained from the first half of OAuth.
    
    Parameters:
    
    clientID - the client ID to use when exchanging the auth code for an access token.
    
    clientSecret - the client secret to use when exchanging the auth code for an access token.
    
    authCode - an auth code obtained from the first half of the OAuth process.
  - BoxAPIConnection
```
public BoxAPIConnection(String clientID,
                        String clientSecret)
```
    Constructs a new BoxAPIConnection.
    
    Parameters:
    
    clientID - the client ID to use when exchanging the auth code for an access token.
    
    clientSecret - the client secret to use when exchanging the auth code for an access token.
  - BoxAPIConnection
```
public BoxAPIConnection(BoxConfig boxConfig)
```
    Constructs a new BoxAPIConnection levaraging BoxConfig.
    
    Parameters:
    
    boxConfig - BoxConfig file, which should have clientId and clientSecret
- Method Detail
  - modifyHttpClientBuilder
```
protected OkHttpClient.Builder modifyHttpClientBuilder(OkHttpClient.Builder httpClientBuilder)
```
    Can be used to modify OkHttp.Builder used to create connection. This method is called after all modifications were done, thus allowing others to create their own connections and further customize builder.
    
    Parameters:
    
    httpClientBuilder - Builder that will be used to create http connection.
    
    Returns:
    
    Modified builder.
  - setProxyAuthenticator
```
public void setProxyAuthenticator(Authenticator authenticator)
```
    Sets a proxy authenticator that will be used when proxy requires authentication. If you use setProxyBasicAuthentication(String, String) it adds an authenticator that performs Basic authorization. By calling this method you can override this behaviour. You do not need to call setProxyBasicAuthentication(String, String) in order to set custom authenticator.
    
    Parameters:
    
    authenticator - Custom authenticator that will be called when proxy asks for authorization.
  - restore
```
public static BoxAPIConnection restore(String clientID,
                                       String clientSecret,
                                       String state)
```
    Restores a BoxAPIConnection from a saved state.
    
    Parameters:
    
    clientID - the client ID to use with the connection.
    
    clientSecret - the client secret to use with the connection.
    
    state - the saved state that was created with save().
    
    Returns:
    
    a restored API connection.
    
    See Also:
    
    save()
  - getAuthorizationURL
```
public static URL getAuthorizationURL(String clientID,
                                      URI redirectUri,
                                      String state,
                                      List<String> scopes)
```
    Returns the default authorization URL which is used to perform the authorization_code based OAuth2 flow. If custom Authorization URL is needed use instance method getAuthorizationURL(java.lang.String, java.net.URI, java.lang.String, java.util.List<java.lang.String>)
    
    Parameters:
    
    clientID - the client ID to use with the connection.
    
    redirectUri - the URL to which Box redirects the browser when authentication completes.
    
    state - the text string that you choose. Box sends the same string to your redirect URL when authentication is complete.
    
    scopes - this optional parameter identifies the Box scopes available to the application once it's authenticated.
    
    Returns:
    
    the authorization URL
  - authenticate
```
public void authenticate(String authCode)
```
    Authenticates the API connection by obtaining access and refresh tokens using the auth code that was obtained from the first half of OAuth.
    
    Parameters:
    
    authCode - the auth code obtained from the first half of the OAuth process.
  - getClientID
```
public String getClientID()
```
    Gets the client ID.
    
    Returns:
    
    the client ID.
  - getClientSecret
```
public String getClientSecret()
```
    Gets the client secret.
    
    Returns:
    
    the client secret.
  - getExpires
```
public long getExpires()
```
    Gets the amount of time for which this connection's access token is valid.
    
    Returns:
    
    the amount of time in milliseconds.
  - setExpires
```
public void setExpires(long milliseconds)
```
    Sets the amount of time for which this connection's access token is valid before it must be refreshed.
    
    Parameters:
    
    milliseconds - the number of milliseconds for which the access token is valid.
  - getTokenURL
```
public String getTokenURL()
```
    Gets the token URL that's used to request access tokens. The default value is "https://www.box.com/api/oauth2/token". The URL is created from baseURL and TOKEN_URL_SUFFIX.
    
    Returns:
    
    the token URL.
  - getRevokeURL
```
public String getRevokeURL()
```
    Returns the URL used for token revocation. The URL is created from baseURL and REVOKE_URL_SUFFIX.
    
    Returns:
    
    The url used for token revocation.
  - getBaseURL
```
public String getBaseURL()
```
    Gets the base URL that's used when sending requests to the Box API. The URL is created from baseURL and API_VERSION. The default value is "https://api.box.com/2.0/".
    
    Returns:
    
    the base URL.
  - setBaseURL
```
public void setBaseURL(String baseURL)
```
    Sets the base URL to be used when sending requests to the Box API. For example, the default base URL is "https://api.box.com/". This method changes how getRevokeURL() and getTokenURL() are constructed.
    
    Parameters:
    
    baseURL - a base URL
  - getBaseUploadURL
```
public String getBaseUploadURL()
```
    Gets the base upload URL that's used when performing file uploads to Box. The URL is created from baseUploadURL and API_VERSION.
    
    Returns:
    
    the base upload URL.
  - setBaseUploadURL
```
public void setBaseUploadURL(String baseUploadURL)
```
    Sets the base upload URL to be used when performing file uploads to Box.
    
    Parameters:
    
    baseUploadURL - a base upload URL.
  - getAuthorizationURL
```
public URL getAuthorizationURL(URI redirectUri,
                               String state,
                               List<String> scopes)
```
    Returns the authorization URL which is used to perform the authorization_code based OAuth2 flow. The URL is created from baseAuthorizationURL and OAUTH_SUFFIX.
    
    Parameters:
    
    redirectUri - the URL to which Box redirects the browser when authentication completes.
    
    state - the text string that you choose. Box sends the same string to your redirect URL when authentication is complete.
    
    scopes - this optional parameter identifies the Box scopes available to the application once it's authenticated.
    
    Returns:
    
    the authorization URL
  - setBaseAuthorizationURL
```
public void setBaseAuthorizationURL(String baseAuthorizationURL)
```
    Sets authorization base URL which is used to perform the authorization_code based OAuth2 flow.
    
    Parameters:
    
    baseAuthorizationURL - Authorization URL. Default value is https://account.box.com/api/.
  - getUserAgent
```
public String getUserAgent()
```
    Gets the user agent that's used when sending requests to the Box API.
    
    Returns:
    
    the user agent.
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    Sets the user agent to be used when sending requests to the Box API.
    
    Parameters:
    
    userAgent - the user agent.
  - getBaseAppUrl
```
public String getBaseAppUrl()
```
    Gets the base App url. Used for e.g. file requests.
    
    Returns:
    
    the base App Url.
  - setBaseAppUrl
```
public void setBaseAppUrl(String baseAppURL)
```
    Sets the base App url. Used for e.g. file requests.
    
    Parameters:
    
    baseAppURL - a base App Url.
  - getAccessToken
```
public String getAccessToken()
```
    Gets an access token that can be used to authenticate an API request. This method will automatically refresh the access token if it has expired since the last call to getAccessToken().
    
    Returns:
    
    a valid access token that can be used to authenticate an API request.
  - setAccessToken
```
public void setAccessToken(String accessToken)
```
    Sets the access token to use when authenticating API requests.
    
    Parameters:
    
    accessToken - a valid access token to use when authenticating API requests.
  - getRefreshLock
```
protected ReadWriteLock getRefreshLock()
```
    Gets the refresh lock to be used when refreshing an access token.
    
    Returns:
    
    the refresh lock.
  - getRefreshToken
```
public String getRefreshToken()
```
    Gets a refresh token that can be used to refresh an access token.
    
    Returns:
    
    a valid refresh token.
  - setRefreshToken
```
public void setRefreshToken(String refreshToken)
```
    Sets the refresh token to use when refreshing an access token.
    
    Parameters:
    
    refreshToken - a valid refresh token.
  - getLastRefresh
```
public long getLastRefresh()
```
    Gets the last time that the access token was refreshed.
    
    Returns:
    
    the last refresh time in milliseconds.
  - setLastRefresh
```
public void setLastRefresh(long lastRefresh)
```
    Sets the last time that the access token was refreshed.
    This value is used when determining if an access token needs to be auto-refreshed. If the amount of time since the last refresh exceeds the access token's expiration time, then the access token will be refreshed.
    
    Parameters:
    
    lastRefresh - the new last refresh time in milliseconds.
  - getAutoRefresh
```
public boolean getAutoRefresh()
```
    Gets whether or not automatic refreshing of this connection's access token is enabled. Defaults to true.
    
    Returns:
    
    true if auto token refresh is enabled; otherwise false.
  - setAutoRefresh
```
public void setAutoRefresh(boolean autoRefresh)
```
    Enables or disables automatic refreshing of this connection's access token. Defaults to true.
    
    Parameters:
    
    autoRefresh - true to enable auto token refresh; otherwise false.
  - getMaxRetryAttempts
```
public int getMaxRetryAttempts()
```
    Gets the maximum number of times an API request will be retried after an error response is received.
    
    Returns:
    
    the maximum number of request attempts.
  - setMaxRetryAttempts
```
public void setMaxRetryAttempts(int attempts)
```
    Sets the maximum number of times an API request will be retried after an error response is received.
    
    Parameters:
    
    attempts - the maximum number of request attempts.
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Gets the connect timeout for this connection in milliseconds.
    
    Returns:
    
    the number of milliseconds to connect before timing out.
  - setConnectTimeout
```
public void setConnectTimeout(int connectTimeout)
```
    Sets the connect timeout for this connection.
    
    Parameters:
    
    connectTimeout - The number of milliseconds to wait for the connection to be established.
  - getReadTimeout
```
public int getReadTimeout()
```
    Gets the read timeout for this connection in milliseconds.
    
    Returns:
    
    the number of milliseconds to wait for bytes to be read before timing out.
  - setReadTimeout
```
public void setReadTimeout(int readTimeout)
```
    Sets the read timeout for this connection.
    
    Parameters:
    
    readTimeout - The number of milliseconds to wait for bytes to be read.
  - getProxy
```
public Proxy getProxy()
```
    Gets the proxy value to use for API calls to Box.
    
    Returns:
    
    the current proxy.
  - setProxy
```
public void setProxy(Proxy proxy)
```
    Sets the proxy to use for API calls to Box.
    
    Parameters:
    
    proxy - the proxy to use for API calls to Box.
  - getProxyUsername
```
public String getProxyUsername()
```
    Gets the username to use for a proxy that requires basic auth.
    
    Returns:
    
    the username to use for a proxy that requires basic auth.
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
    Deprecated. Use setProxyBasicAuthentication(String, String)
    
    Sets the username to use for a proxy that requires basic auth.
    
    Parameters:
    
    proxyUsername - the username to use for a proxy that requires basic auth.
  - getProxyPassword
```
public String getProxyPassword()
```
    Gets the password to use for a proxy that requires basic auth.
    
    Returns:
    
    the password to use for a proxy that requires basic auth.
  - setProxyBasicAuthentication
```
public void setProxyBasicAuthentication(String proxyUsername,
                                        String proxyPassword)
```
    Sets the proxy user and password used in basic authentication
    
    Parameters:
    
    proxyUsername - Username to use for a proxy that requires basic auth.
    
    proxyPassword - Password to use for a proxy that requires basic auth.
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
    Deprecated. Use setProxyBasicAuthentication(String, String)
    
    Sets the password to use for a proxy that requires basic auth.
    
    Parameters:
    
    proxyPassword - the password to use for a proxy that requires basic auth.
  - canRefresh
```
public boolean canRefresh()
```
    Determines if this connection's access token can be refreshed. An access token cannot be refreshed if a refresh token was never set.
    
    Returns:
    
    true if the access token can be refreshed; otherwise false.
  - needsRefresh
```
public boolean needsRefresh()
```
    Determines if this connection's access token has expired and needs to be refreshed.
    
    Returns:
    
    true if the access token needs to be refreshed; otherwise false.
  - refresh
```
public void refresh()
```
    Refresh's this connection's access token using its refresh token.
    
    Throws:
    
    IllegalStateException - if this connection's access token cannot be refreshed.
  - restore
```
public void restore(String state)
```
    Restores a saved connection state into this BoxAPIConnection.
    
    Parameters:
    
    state - the saved state that was created with save().
    
    See Also:
    
    save()
  - getKeyValueOrDefault
```
protected String getKeyValueOrDefault(JsonObject json,
                                      String key,
                                      String defaultValue)
```
  - notifyRefresh
```
protected void notifyRefresh()
```
    Notifies a refresh event to all the listeners.
  - notifyError
```
protected void notifyError(BoxAPIException error)
```
    Notifies an error event to all the listeners.
    
    Parameters:
    
    error - A BoxAPIException instance.
  - addListener
```
public void addListener(BoxAPIConnectionListener listener)
```
    Add a listener to listen to Box API connection events.
    
    Parameters:
    
    listener - a listener to listen to Box API connection.
  - removeListener
```
public void removeListener(BoxAPIConnectionListener listener)
```
    Remove a listener listening to Box API connection events.
    
    Parameters:
    
    listener - the listener to remove.
  - getRequestInterceptor
```
public RequestInterceptor getRequestInterceptor()
```
    Gets the RequestInterceptor associated with this API connection.
    
    Returns:
    
    the RequestInterceptor associated with this API connection.
  - setRequestInterceptor
```
public void setRequestInterceptor(RequestInterceptor interceptor)
```
    Sets a RequestInterceptor that can intercept requests and manipulate them before they're sent to the Box API.
    
    Parameters:
    
    interceptor - the RequestInterceptor.
  - getLowerScopedToken
```
public ScopedToken getLowerScopedToken(List<String> scopes,
                                       String resource)
```
    Get a lower-scoped token restricted to a resource for the list of scopes that are passed.
    
    Parameters:
    
    scopes - the list of scopes to which the new token should be restricted for
    
    resource - the resource for which the new token has to be obtained
    
    Returns:
    
    scopedToken which has access token and other details
    
    Throws:
    
    BoxAPIException - if resource is not a valid Box API endpoint or shared link
  - determineResourceLinkType
```
protected BoxAPIConnection.ResourceLinkType determineResourceLinkType(String resourceLink)
```
    Determines the type of resource, given a link to a Box resource.
    
    Parameters:
    
    resourceLink - the resource URL to check
    
    Returns:
    
    ResourceLinkType that categorizes the provided resourceLink
  - revokeToken
```
public void revokeToken()
```
    Revokes the tokens associated with this API connection. This results in the connection no longer being able to make API calls until a fresh authorization is made by calling authenticate()
  - save
```
public String save()
```
    Saves the state of this connection to a string so that it can be persisted and restored at a later time.
    Note that proxy settings aren't automatically saved or restored. This is mainly due to security concerns around persisting proxy authentication details to the state string. If your connection uses a proxy, you will have to manually configure it again after restoring the connection.
    
    Returns:
    
    the state of this connection.
    
    See Also:
    
    restore(java.lang.String, java.lang.String, java.lang.String)
  - setCustomHeader
```
public void setCustomHeader(String header,
                            String value)
```
    Sets a custom header to be sent on all requests through this API connection.
    
    Parameters:
    
    header - the header name.
    
    value - the header value.
  - removeCustomHeader
```
public void removeCustomHeader(String header)
```
    Removes a custom header, so it will no longer be sent on requests through this API connection.
    
    Parameters:
    
    header - the header name.
  - suppressNotifications
```
public void suppressNotifications()
```
    Suppresses email notifications from API actions. This is typically used by security or admin applications to prevent spamming end users when doing automated processing on their content.
  - enableNotifications
```
public void enableNotifications()
```
    Re-enable email notifications from API actions if they have been suppressed.
    
    See Also:
    
    suppressNotifications()
  - asUser
```
public void asUser(String userID)
```
    Set this API connection to make API calls on behalf of another users, impersonating them. This functionality can only be used by admins and service accounts.
    
    Parameters:
    
    userID - the ID of the user to act as.
  - asSelf
```
public void asSelf()
```
    Sets this API connection to make API calls on behalf of the user with whom the access token is associated. This undoes any previous calls to asUser().
    
    See Also:
    
    asUser(java.lang.String)
  - configureSslCertificatesValidation
```
public void configureSslCertificatesValidation(X509TrustManager trustManager,
                                               HostnameVerifier hostnameVerifier)
```
    Used to override default SSL certification handling. For example, you can provide your own trust manager or hostname verifier to allow self-signed certificates. You can check examples here.
    
    Parameters:
    
    trustManager - TrustManager that verifies certificates are valid.
    
    hostnameVerifier - HostnameVerifier that allows you to specify what hostnames are allowed.
  - extractTokens
```
protected void extractTokens(JsonObject jsonObject)
```
  - createTokenRequest
```
protected BoxAPIRequest createTokenRequest(URL url)
```
  - getTrustManager
```
protected X509TrustManager getTrustManager()
```
  - getHostnameVerifier
```
protected HostnameVerifier getHostnameVerifier()
```

Class BoxAPIConnection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

DEFAULT_TRUST_MANAGER

DEFAULT_HOSTNAME_VERIFIER

DEFAULT_MAX_RETRIES

DEFAULT_BASE_AUTHORIZATION_URL

Constructor Detail

BoxAPIConnection

BoxAPIConnection

BoxAPIConnection

BoxAPIConnection

BoxAPIConnection

Method Detail

modifyHttpClientBuilder

setProxyAuthenticator

restore

getAuthorizationURL

authenticate

getClientID

getClientSecret

getExpires

setExpires

getTokenURL

getRevokeURL

getBaseURL

setBaseURL

getBaseUploadURL

setBaseUploadURL

getAuthorizationURL

setBaseAuthorizationURL

getUserAgent

setUserAgent

getBaseAppUrl

setBaseAppUrl

getAccessToken

setAccessToken

getRefreshLock

getRefreshToken

setRefreshToken

getLastRefresh

setLastRefresh

getAutoRefresh

setAutoRefresh

getMaxRetryAttempts

setMaxRetryAttempts

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getProxy

setProxy

getProxyUsername

setProxyUsername

getProxyPassword

setProxyBasicAuthentication

setProxyPassword

canRefresh

needsRefresh

refresh

restore

getKeyValueOrDefault

notifyRefresh

notifyError

addListener

removeListener

getRequestInterceptor

setRequestInterceptor

getLowerScopedToken

determineResourceLinkType

revokeToken

save

setCustomHeader

removeCustomHeader

suppressNotifications

enableNotifications