com.box.sdk

Class BoxConfig

Object

BoxConfig

public class BoxConfig
extends Object

Contains Box configurations.

Constructor Summary

Constructors

Constructor and Description
BoxConfig(String clientId, String clientSecret) Creates a configuration with a clientId and clientSecret.
BoxConfig(String clientId, String clientSecret, String enterpriseId, JWTEncryptionPreferences jwtEncryptionPreferences) Creates a configuration with clientId, clientSecret and JWTEncryptionPreferences.
BoxConfig(String clientId, String clientSecret, String enterpriseId, String publicKeyID, String privateKey, String privateKeyPassword) Creates a configuration with RSA_SHA_256 as the encryption algorithm.
BoxConfig(String clientId, String clientSecret, String enterpriseId, String publicKeyID, String privateKey, String privateKeyPassword, EncryptionAlgorithm encryptionAlgorithm) Creates a configuration with clientId, clientSecret, publicKeyID, privateKey, privateKeyPassword.

Method Summary

Modifier and Type	Method and Description
String	getClientId()
String	getClientSecret()
String	getEnterpriseId()
JWTEncryptionPreferences	getJWTEncryptionPreferences()
static BoxConfig	readFrom(Reader reader) Reads OAuth 2.0 with JWT app configurations from the reader.
static BoxConfig	readFrom(String jsonString) Reads OAuth 2.0 with JWT app configurations from the Json string.
void	setClientId(String clientId)
void	setClientSecret(String clientSecret)
void	setEnterpriseId(String enterpriseId)
void	setJWTEncryptionPreferences(JWTEncryptionPreferences jwtEncryptionPreferences)
void	setPrivateKeyDecryptor(IPrivateKeyDecryptor privateKeyDecryptor) Sets a custom decryptor used for decrypting the private key.

Methods inherited from class Object

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

Constructor Detail

BoxConfig

public BoxConfig(String clientId,
                 String clientSecret)

Creates a configuration with a clientId and clientSecret.

Parameters:

clientId - the client ID of the application

clientSecret - the client secret of the application

BoxConfig

public BoxConfig(String clientId,
                 String clientSecret,
                 String enterpriseId,
                 JWTEncryptionPreferences jwtEncryptionPreferences)

Creates a configuration with clientId, clientSecret and JWTEncryptionPreferences.

Parameters:

clientId - the client ID of the application

clientSecret - the client secret of the application

enterpriseId - the enterprise ID of the box account

jwtEncryptionPreferences - the JWTEncryptionPreferences of the application

BoxConfig

public BoxConfig(String clientId,
                 String clientSecret,
                 String enterpriseId,
                 String publicKeyID,
                 String privateKey,
                 String privateKeyPassword,
                 EncryptionAlgorithm encryptionAlgorithm)

Creates a configuration with clientId, clientSecret, publicKeyID, privateKey, privateKeyPassword. and an encryptionAlgorithm.

Parameters:

clientId - the client ID of the application

clientSecret - the client secret of the application

enterpriseId - the enterprise ID of the box account

publicKeyID - the unique ID of the uploaded public key

privateKey - the private key used to sign JWT requests

privateKeyPassword - the passphrase for the private key

encryptionAlgorithm - the encryption algorithm that has to be used for signing JWT requests

BoxConfig

public BoxConfig(String clientId,
                 String clientSecret,
                 String enterpriseId,
                 String publicKeyID,
                 String privateKey,
                 String privateKeyPassword)

Creates a configuration with RSA_SHA_256 as the encryption algorithm.

Parameters:

clientId - the client ID of the application

clientSecret - the client secret of the application

enterpriseId - the enterprise ID of the box account

publicKeyID - the unique ID of the uploaded public key

privateKey - the private key used to sign JWT requests

privateKeyPassword - the passphrase for the private key

Method Detail

readFrom

public static BoxConfig readFrom(Reader reader)
                          throws IOException

Reads OAuth 2.0 with JWT app configurations from the reader. The file should be in JSON format.

Parameters:

reader - a reader object which points to a JSON formatted configuration file

Returns:

a new Instance of BoxConfig

Throws:

IOException - when unable to access the mapping file's content of the reader

readFrom

public static BoxConfig readFrom(String jsonString)

Reads OAuth 2.0 with JWT app configurations from the Json string.

Parameters:

jsonString - a Json stringrepresenting formatted configuration file

Returns:

a new Instance of BoxConfig

getClientSecret

public String getClientSecret()

Returns:

client secret

setClientSecret

public void setClientSecret(String clientSecret)

Parameters:

clientSecret - client secret of the application

getEnterpriseId

public String getEnterpriseId()

Returns:

enterprise ID

setEnterpriseId

public void setEnterpriseId(String enterpriseId)

Parameters:

enterpriseId - enterprise ID of the application

getJWTEncryptionPreferences

public JWTEncryptionPreferences getJWTEncryptionPreferences()

Returns:

JWT Encryption Preferences

setJWTEncryptionPreferences

public void setJWTEncryptionPreferences(JWTEncryptionPreferences jwtEncryptionPreferences)

Parameters:

jwtEncryptionPreferences - encryption preferences for JWT based authentication

getClientId

public String getClientId()

Returns:

client ID

setClientId

public void setClientId(String clientId)

Parameters:

clientId - client ID of the Application

setPrivateKeyDecryptor

public void setPrivateKeyDecryptor(IPrivateKeyDecryptor privateKeyDecryptor)

Sets a custom decryptor used for decrypting the private key.

Parameters:

privateKeyDecryptor - privateKeyDecryptor the decryptor used for decrypting the private key.