com.box.sdk

Class BoxCCGAPIConnection

Object

BoxAPIConnection

BoxCCGAPIConnection

public final class BoxCCGAPIConnection
extends BoxAPIConnection

Creates and manages Client Credentials Grant API connection.

Nested Class Summary

Nested classes/interfaces inherited from class BoxAPIConnection

BoxAPIConnection.ResourceLinkType

Field Summary

Fields inherited from class BoxAPIConnection

DEFAULT_BASE_AUTHORIZATION_URL, DEFAULT_HOSTNAME_VERIFIER, DEFAULT_MAX_RETRIES, DEFAULT_TRUST_MANAGER

Method Summary

Modifier and Type	Method and Description
static BoxCCGAPIConnection	applicationServiceAccountConnection(String clientId, String clientSecret, String enterpriseId) Creates connection that authenticates as a Service Account
boolean	canRefresh() Determines if this connection's access token can be refreshed.
protected BoxAPIRequest	createTokenRequest(URL url)
protected void	extractTokens(JsonObject jsonObject)
boolean	isUserConnection()
void	restore(String state) Restores a saved connection state into this BoxAPIConnection.
static BoxCCGAPIConnection	restore(String clientID, String clientSecret, String state) Restores a BoxAPIConnection from a saved state.
String	save() Saves the state of this connection to a string so that it can be persisted and restored at a later time.
static BoxCCGAPIConnection	userConnection(String clientId, String clientSecret, String userId) Creates connection that authenticates as a User

Methods inherited from class BoxAPIConnection

addListener, asSelf, asUser, authenticate, configureSslCertificatesValidation, createNewCall, determineResourceLinkType, enableNotifications, getAccessToken, getAuthorizationURL, getAuthorizationURL, getAutoRefresh, getBaseAppUrl, getBaseUploadURL, getBaseURL, getClientID, getClientSecret, getConnectTimeout, getExpires, getHostnameVerifier, getKeyValueOrDefault, getLastRefresh, getLowerScopedToken, getMaxRetryAttempts, getProxy, getProxyPassword, getProxyUsername, getReadTimeout, getRefreshLock, getRefreshToken, getRequestInterceptor, getRevokeURL, getTokenURL, getTrustManager, getUserAgent, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, refresh, removeCustomHeader, removeListener, revokeToken, setAccessToken, setAutoRefresh, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, suppressNotifications

Methods inherited from class Object

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

Method Detail

applicationServiceAccountConnection

public static BoxCCGAPIConnection applicationServiceAccountConnection(String clientId,
                                                                      String clientSecret,
                                                                      String enterpriseId)

Creates connection that authenticates as a Service Account

Parameters:

clientId - the client ID to use when getting the access token.

clientSecret - the client secret to use when getting the access token.

enterpriseId - the enterprise ID to use when getting the access token.

Returns:

Client Credentials Grant API connection.

userConnection

public static BoxCCGAPIConnection userConnection(String clientId,
                                                 String clientSecret,
                                                 String userId)

Creates connection that authenticates as a User

Parameters:

clientId - the client ID to use when getting the access token.

clientSecret - the client secret to use when getting the access token.

userId - the user ID to use when getting the access token.

Returns:

Client Credentials Grant API connection.

restore

public static BoxCCGAPIConnection 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()

createTokenRequest

protected BoxAPIRequest createTokenRequest(URL url)

Overrides:

createTokenRequest in class BoxAPIConnection

extractTokens

protected void extractTokens(JsonObject jsonObject)

Overrides:

extractTokens in class BoxAPIConnection

canRefresh

public boolean canRefresh()

Description copied from class: BoxAPIConnection

Determines if this connection's access token can be refreshed. An access token cannot be refreshed if a refresh token was never set.

Overrides:

canRefresh in class BoxAPIConnection

Returns:

true if the access token can be refreshed; otherwise false.

isUserConnection

public boolean isUserConnection()

save

public String save()

Description copied from class: BoxAPIConnection

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.

Overrides:

save in class BoxAPIConnection

Returns:

the state of this connection.

See Also:

BoxAPIConnection.restore(java.lang.String, java.lang.String, java.lang.String)

restore

public void restore(String state)

Description copied from class: BoxAPIConnection

Restores a saved connection state into this BoxAPIConnection.

Overrides:

restore in class BoxAPIConnection

Parameters:

state - the saved state that was created with BoxAPIConnection.save().

See Also:

BoxAPIConnection.save()