com.box.sdk

Class BoxDeveloperEditionAPIConnection

Object

BoxAPIConnection

BoxDeveloperEditionAPIConnection

public class BoxDeveloperEditionAPIConnection
extends BoxAPIConnection

Represents an authenticated Box Developer Edition connection to the Box API.

This class handles everything for Box Developer Edition that isn't already handled by BoxAPIConnection.

Field Summary

Fields inherited from class BoxAPIConnection

DEFAULT_MAX_ATTEMPTS

Constructor Summary

Constructors

Constructor and Description
BoxDeveloperEditionAPIConnection(String entityId, DeveloperEditionEntityType entityType, BoxConfig boxConfig, IAccessTokenCache accessTokenCache) Constructs a new BoxDeveloperEditionAPIConnection.
BoxDeveloperEditionAPIConnection(String entityId, DeveloperEditionEntityType entityType, String clientID, String clientSecret, JWTEncryptionPreferences encryptionPref) Deprecated. Use the version of this constructor that accepts an IAccessTokenCache to prevent unneeded requests to Box for access tokens.
BoxDeveloperEditionAPIConnection(String entityId, DeveloperEditionEntityType entityType, String clientID, String clientSecret, JWTEncryptionPreferences encryptionPref, IAccessTokenCache accessTokenCache) Constructs a new BoxDeveloperEditionAPIConnection leveraging an access token cache.

Method Summary

Modifier and Type	Method and Description
void	authenticate() Authenticates the API connection for Box Developer Edition.
void	authenticate(String authCode) Disabling the non-Box Developer Edition authenticate method.
boolean	canRefresh() BoxDeveloperEditionAPIConnection can always refresh, but this method is required elsewhere.
static BoxDeveloperEditionAPIConnection	getAppEnterpriseConnection(BoxConfig boxConfig) Creates a new Box Developer Edition connection with enterprise token leveraging BoxConfig.
static BoxDeveloperEditionAPIConnection	getAppEnterpriseConnection(BoxConfig boxConfig, IAccessTokenCache accessTokenCache) Creates a new Box Developer Edition connection with enterprise token leveraging BoxConfig and access token cache.
static BoxDeveloperEditionAPIConnection	getAppEnterpriseConnection(String enterpriseId, String clientId, String clientSecret, JWTEncryptionPreferences encryptionPref) Deprecated. Use the version of this method that accepts an IAccessTokenCache to prevent unneeded requests to Box for access tokens.
static BoxDeveloperEditionAPIConnection	getAppEnterpriseConnection(String enterpriseId, String clientId, String clientSecret, JWTEncryptionPreferences encryptionPref, IAccessTokenCache accessTokenCache) Creates a new Box Developer Edition connection with enterprise token leveraging an access token cache.
static BoxDeveloperEditionAPIConnection	getAppUserConnection(String userId, BoxConfig boxConfig) Creates a new Box Developer Edition connection with App User token levaraging BoxConfig.
static BoxDeveloperEditionAPIConnection	getAppUserConnection(String userId, BoxConfig boxConfig, IAccessTokenCache accessTokenCache) Creates a new Box Developer Edition connection with App User token leveraging BoxConfig and access token cache.
static BoxDeveloperEditionAPIConnection	getAppUserConnection(String userId, String clientId, String clientSecret, JWTEncryptionPreferences encryptionPref) Deprecated. Use the version of this method that accepts an IAccessTokenCache to prevent unneeded requests to Box for access tokens.
static BoxDeveloperEditionAPIConnection	getAppUserConnection(String userId, String clientId, String clientSecret, JWTEncryptionPreferences encryptionPref, IAccessTokenCache accessTokenCache) Creates a new Box Developer Edition connection with App User token.
void	refresh() Refresh's this connection's access token using Box Developer Edition.

Methods inherited from class BoxAPIConnection

addListener, getAccessToken, getAuthorizationURL, getAutoRefresh, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getExpires, getLastRefresh, getLowerScopedToken, getMaxRequestAttempts, getProxy, getProxyPassword, getProxyUsername, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getUserAgent, needsRefresh, notifyError, notifyRefresh, removeListener, restore, restore, revokeToken, save, setAccessToken, setAutoRefresh, setBaseUploadURL, setBaseURL, setExpires, setLastRefresh, setMaxRequestAttempts, setProxy, setProxyPassword, setProxyUsername, setRefreshToken, setRequestInterceptor, setRevokeURL, setTokenURL, setUserAgent

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxDeveloperEditionAPIConnection

@Deprecated
public BoxDeveloperEditionAPIConnection(String entityId,
                                                    DeveloperEditionEntityType entityType,
                                                    String clientID,
                                                    String clientSecret,
                                                    JWTEncryptionPreferences encryptionPref)

Deprecated. Use the version of this constructor that accepts an IAccessTokenCache to prevent unneeded requests to Box for access tokens.

Constructs a new BoxDeveloperEditionAPIConnection.

Parameters:

entityId - enterprise ID or a user ID.

entityType - the type of entityId.

clientID - the client ID to use when exchanging the JWT assertion for an access token.

clientSecret - the client secret to use when exchanging the JWT assertion for an access token.

encryptionPref - the encryption preferences for signing the JWT.

BoxDeveloperEditionAPIConnection

public BoxDeveloperEditionAPIConnection(String entityId,
                                        DeveloperEditionEntityType entityType,
                                        String clientID,
                                        String clientSecret,
                                        JWTEncryptionPreferences encryptionPref,
                                        IAccessTokenCache accessTokenCache)

Constructs a new BoxDeveloperEditionAPIConnection leveraging an access token cache.

Parameters:

entityId - enterprise ID or a user ID.

entityType - the type of entityId.

clientID - the client ID to use when exchanging the JWT assertion for an access token.

clientSecret - the client secret to use when exchanging the JWT assertion for an access token.

encryptionPref - the encryption preferences for signing the JWT.

accessTokenCache - the cache for storing access token information (to minimize fetching new tokens)

BoxDeveloperEditionAPIConnection

public BoxDeveloperEditionAPIConnection(String entityId,
                                        DeveloperEditionEntityType entityType,
                                        BoxConfig boxConfig,
                                        IAccessTokenCache accessTokenCache)

Constructs a new BoxDeveloperEditionAPIConnection.

Parameters:

entityId - enterprise ID or a user ID.

entityType - the type of entityId.

boxConfig - box configuration settings object

accessTokenCache - the cache for storing access token information (to minimize fetching new tokens)

Method Detail

getAppEnterpriseConnection

@Deprecated
public static BoxDeveloperEditionAPIConnection getAppEnterpriseConnection(String enterpriseId,
                                                                                      String clientId,
                                                                                      String clientSecret,
                                                                                      JWTEncryptionPreferences encryptionPref)

Deprecated. Use the version of this method that accepts an IAccessTokenCache to prevent unneeded requests to Box for access tokens.

Creates a new Box Developer Edition connection with enterprise token.

Parameters:

enterpriseId - the enterprise ID to use for requesting access token.

clientId - the client ID to use when exchanging the JWT assertion for an access token.

clientSecret - the client secret to use when exchanging the JWT assertion for an access token.

encryptionPref - the encryption preferences for signing the JWT.

Returns:

a new instance of BoxAPIConnection.

getAppEnterpriseConnection

public static BoxDeveloperEditionAPIConnection getAppEnterpriseConnection(String enterpriseId,
                                                                          String clientId,
                                                                          String clientSecret,
                                                                          JWTEncryptionPreferences encryptionPref,
                                                                          IAccessTokenCache accessTokenCache)

Creates a new Box Developer Edition connection with enterprise token leveraging an access token cache.

Parameters:

enterpriseId - the enterprise ID to use for requesting access token.

clientId - the client ID to use when exchanging the JWT assertion for an access token.

clientSecret - the client secret to use when exchanging the JWT assertion for an access token.

encryptionPref - the encryption preferences for signing the JWT.

accessTokenCache - the cache for storing access token information (to minimize fetching new tokens)

Returns:

a new instance of BoxAPIConnection.

getAppEnterpriseConnection

public static BoxDeveloperEditionAPIConnection getAppEnterpriseConnection(BoxConfig boxConfig)

Creates a new Box Developer Edition connection with enterprise token leveraging BoxConfig.

Parameters:

boxConfig - box configuration settings object

Returns:

a new instance of BoxAPIConnection.

getAppEnterpriseConnection

public static BoxDeveloperEditionAPIConnection getAppEnterpriseConnection(BoxConfig boxConfig,
                                                                          IAccessTokenCache accessTokenCache)

Creates a new Box Developer Edition connection with enterprise token leveraging BoxConfig and access token cache.

Parameters:

boxConfig - box configuration settings object

accessTokenCache - the cache for storing access token information (to minimize fetching new tokens)

Returns:

a new instance of BoxAPIConnection.

getAppUserConnection

@Deprecated
public static BoxDeveloperEditionAPIConnection getAppUserConnection(String userId,
                                                                                String clientId,
                                                                                String clientSecret,
                                                                                JWTEncryptionPreferences encryptionPref)

Deprecated. Use the version of this method that accepts an IAccessTokenCache to prevent unneeded requests to Box for access tokens.

Creates a new Box Developer Edition connection with App User token.

Parameters:

userId - the user ID to use for an App User.

clientId - the client ID to use when exchanging the JWT assertion for an access token.

clientSecret - the client secret to use when exchanging the JWT assertion for an access token.

encryptionPref - the encryption preferences for signing the JWT.

Returns:

a new instance of BoxAPIConnection.

getAppUserConnection

public static BoxDeveloperEditionAPIConnection getAppUserConnection(String userId,
                                                                    String clientId,
                                                                    String clientSecret,
                                                                    JWTEncryptionPreferences encryptionPref,
                                                                    IAccessTokenCache accessTokenCache)

Creates a new Box Developer Edition connection with App User token.

Parameters:

userId - the user ID to use for an App User.

clientId - the client ID to use when exchanging the JWT assertion for an access token.

clientSecret - the client secret to use when exchanging the JWT assertion for an access token.

encryptionPref - the encryption preferences for signing the JWT.

accessTokenCache - the cache for storing access token information (to minimize fetching new tokens)

Returns:

a new instance of BoxAPIConnection.

getAppUserConnection

public static BoxDeveloperEditionAPIConnection getAppUserConnection(String userId,
                                                                    BoxConfig boxConfig)

Creates a new Box Developer Edition connection with App User token levaraging BoxConfig.

Parameters:

userId - the user ID to use for an App User.

boxConfig - box configuration settings object

Returns:

a new instance of BoxAPIConnection.

getAppUserConnection

public static BoxDeveloperEditionAPIConnection getAppUserConnection(String userId,
                                                                    BoxConfig boxConfig,
                                                                    IAccessTokenCache accessTokenCache)

Creates a new Box Developer Edition connection with App User token leveraging BoxConfig and access token cache.

Parameters:

userId - the user ID to use for an App User.

boxConfig - box configuration settings object

accessTokenCache - the cache for storing access token information (to minimize fetching new tokens)

Returns:

a new instance of BoxAPIConnection.

authenticate

public void authenticate(String authCode)

Disabling the non-Box Developer Edition authenticate method.

Overrides:

authenticate in class BoxAPIConnection

Parameters:

authCode - an auth code obtained from the first half of the OAuth process.

authenticate

public void authenticate()

Authenticates the API connection for Box Developer Edition.

canRefresh

public boolean canRefresh()

BoxDeveloperEditionAPIConnection can always refresh, but this method is required elsewhere.

Overrides:

canRefresh in class BoxAPIConnection

Returns:

true always.

refresh

public void refresh()

Refresh's this connection's access token using Box Developer Edition.

Overrides:

refresh in class BoxAPIConnection

Throws:

IllegalStateException - if this connection's access token cannot be refreshed.