com.box.sdk

Class BoxTransactionalAPIConnection

Object

BoxAPIConnection

BoxTransactionalAPIConnection

public class BoxTransactionalAPIConnection
extends BoxAPIConnection

Represents an authenticated transactional connection to the Box API.

This class handles everything for transactional API that isn't already handled by BoxAPIConnection.

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

Constructor Summary

Constructors

Constructor and Description
BoxTransactionalAPIConnection(String accessToken) Constructs a new BoxTransactionalAPIConnection that authenticates with an access token.

Method Summary

Modifier and Type	Method and Description
void	authenticate(String authCode) Disabling the non-Box Developer Edition authenticate method.
boolean	canRefresh() BoxTransactionalAPIConnection can never refresh.
static BoxAPIConnection	getTransactionConnection(String accessToken, String scope) Request a scoped transactional token.
static BoxAPIConnection	getTransactionConnection(String accessToken, String scope, String resource) Request a scoped transactional token for a particular resource.
void	refresh() Transactional auth does not support token refreshes.
void	setAutoRefresh(boolean autoRefresh) Auto refresh is not available for transactional auth.

Methods inherited from class BoxAPIConnection

addListener, asSelf, asUser, configureSslCertificatesValidation, createNewCall, createTokenRequest, determineResourceLinkType, enableNotifications, extractTokens, 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, getUseZstdCompression, modifyHttpClientBuilder, needsRefresh, notifyError, notifyRefresh, removeCustomHeader, removeListener, restore, restore, revokeToken, save, setAccessToken, setBaseAppUrl, setBaseAuthorizationURL, setBaseUploadURL, setBaseURL, setConnectTimeout, setCustomHeader, setExpires, setLastRefresh, setMaxRetryAttempts, setProxy, setProxyAuthenticator, setProxyBasicAuthentication, setProxyPassword, setProxyUsername, setReadTimeout, setRefreshToken, setRequestInterceptor, setUserAgent, setUseZstdCompression, suppressNotifications

Methods inherited from class Object

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

Constructor Detail

BoxTransactionalAPIConnection

public BoxTransactionalAPIConnection(String accessToken)

Constructs a new BoxTransactionalAPIConnection that authenticates with an access token.

Parameters:

accessToken - a transactional auth access token.

Method Detail

getTransactionConnection

public static BoxAPIConnection getTransactionConnection(String accessToken,
                                                        String scope)

Request a scoped transactional token.

Parameters:

accessToken - application access token.

scope - scope of transactional token.

Returns:

a BoxAPIConnection which can be used to perform transactional requests.

getTransactionConnection

public static BoxAPIConnection getTransactionConnection(String accessToken,
                                                        String scope,
                                                        String resource)

Request a scoped transactional token for a particular resource.

Parameters:

accessToken - application access token.

scope - scope of transactional token.

resource - resource transactional token has access to.

Returns:

a BoxAPIConnection which can be used to perform transactional requests.

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.

Throws:

UnsupportedOperationException - Box Transactional API does not support authentication with an auth code

canRefresh

public boolean canRefresh()

BoxTransactionalAPIConnection can never refresh.

Overrides:

canRefresh in class BoxAPIConnection

Returns:

false always.

setAutoRefresh

public void setAutoRefresh(boolean autoRefresh)

Auto refresh is not available for transactional auth.

Overrides:

setAutoRefresh in class BoxAPIConnection

Parameters:

autoRefresh - true to enable auto token refresh; otherwise false.

Throws:

UnsupportedOperationException - Box Transactional API tokens can not be refreshed

refresh

public void refresh()

Transactional auth does not support token refreshes.

Overrides:

refresh in class BoxAPIConnection

Throws:

UnsupportedOperationException - Box Transactional API tokens can not be refreshed